Skip to main content

​
Platform API

Manage identity, organization context, API keys, billing, OAuth metadata, usage events, and platform event records.

​
Use This API To

  • Read current principal, organization, API keys, and billing state.
  • Create API keys and billing sessions from server-side flows.
  • Export platform events and inspect OAuth metadata for hosted MCP.

​
Before You Call

1

Call platform endpoints from trusted server-side contexts

Call platform endpoints from trusted server-side contexts.
2

Never expose API key secrets in client logs or screenshots

Never expose API key secrets in client logs or screenshots.
3

Use billing and plan headers to enforce spend controls

Use billing and plan headers to enforce spend controls.

​
Endpoints

GET /.well-known/oauth-authorization-server

Return or proxy OAuth authorization server metadata for the configured WorkOS tenant

GET /.well-known/oauth-protected-resource

Return OAuth protected resource metadata for hosted MCP and API clients

GET /v1/api_keys

List API keys for the current organization

POST /v1/api_keys

Create a new API key for the current organization

GET /v1/billing

Return the current organization’s billing snapshot, including pricing state, budget controls, and billing provider state

PUT /v1/billing/budget

Update organization-level spend caps, soft caps, and approval thresholds for PAYG usage

POST /v1/billing/checkout

Create a Stripe Checkout session for a self-serve Personal or Team SEC API plan

POST /v1/billing/payg/activate

Create a Stripe Checkout setup session that activates Pay As You Go card-on-file billing

POST /v1/billing/portal

Create a Stripe Billing Portal session for the current organization

POST /v1/billing/quote

Quote a billable workflow or meter class against the current billing plan and budget gates

GET /v1/billing/rates

Return the public pricing catalog, plan metadata, and meter-family rates

GET /v1/events

List canonical event, webhook delivery, and stream records for the current organization

GET /v1/events/auditor-changes

Return 8-K Item 4.01 auditor change events with change-type classification (dismissal, resignation, engagement)

GET /v1/events/enforcement

Return official SEC litigation releases and administrative proceedings with explicit release-source semantics and shared trace references

GET /v1/events/export

Export filtered canonical events as JSON or NDJSON

GET /v1/events/officer-changes

Return 8-K Item 5.02 officer and director change events with change-type classification (appointment, departure, resignation, termination)

GET /v1/events/restatements

Return 8-K Item 4.02 restatement and non-reliance events with severity classification and affected-period extraction

GET /v1/events/voting-results

Return 8-K Item 5.07 voting results with structured proposals, vote counts, and approval outcomes

GET /v1/me

Return the current authenticated principal and organization context

GET /v1/org

Return the current organization profile