Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.secapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Operations

Operations pages are for the people who have to prove the system is healthy, explain what happened, and ship without guessing.

​
Health and readiness

Liveness

GET /healthz is part of release verification and should stay green before you treat the API as ship-ready.

Readiness

GET /readyz is part of release verification and fails closed when the platform cannot safely serve traffic.

​
Trace propagation

1

Request entry

Every response includes Request-Id and traceparent.
2

Downstream fetches

Datastream forwards request correlation headers on downstream SEC fetches so ingest and serving traces stay tied together.
3

Operator follow-up

Use those IDs in request diagnostics, replay tools, and support workflows before trying to reproduce blindly.

​
Deploy verification

Run: 
OMNI_DATASTREAM_BASE_URL=https://your-api.example.com \
OMNI_DATASTREAM_API_KEY=... \
bun run verify:release
The verification script checks:
  • /healthz
  • /readyz
  • OAuth discovery endpoints
  • /v1/limits when an API key is supplied

​
Current production posture

  • WorkOS discovery is live and returns 200
  • release verification should treat /.well-known/oauth-authorization-server as a required 200
  • launch-readiness should be read from the current release-verification artifact rather than assumed from this page alone
If readiness is green but a workflow still looks stale, check freshness metadata and request diagnostics before assuming ingestion is healthy. Serving health and content freshness are related, but they are not the same signal.

Freshness and trust

Read how freshness and provenance are measured and published.

Benchmark workflows

Review the current performance and parity methodology.

Auth and pricing

Check auth, limits, billing, and onboarding posture.