Skip to main content
​
v1, additive
  • Test mode. Create a key with "mode": "test" to build against the API without spending: its jobs make no model, OCR or enrichment calls, are seen only by test keys, and are not metered. Webhook payloads carry livemode. See Test mode.
  • Team. /v1/members lists members, sends and revokes invitations, changes roles and removes people; POST /v1/tenant/admin-portal opens the WorkOS Admin Portal to set up SSO and directory sync; POST /v1/auth/logout ends a session. New permission members:manage. See Team.
  • Export. GET /v1/tenant/export streams a ZIP of everything your tenant holds. See Your data.
  • Retention and budget. Every new tenant starts with a retention period and a monthly model budget.
  • Encryption. Job requests and results, cached reads, stored model answers, event payloads, corrections and email subjects are encrypted with your tenant’s own key in the database, as documents already were.
  • Versioning. The versioning policy: /v1 changes only by addition, and a deprecated endpoint sends Deprecation and Sunset headers before it goes.
​
v1
The first release: packet parsing (POST /v1/parse), jobs and corrections, webhooks, email intake and mailboxes, emails and threads, integrations, usage and quality, API keys and the audit log.