Skip to main content
The Ontora API has regional hosts:
Use the host matching the dashboard where the workspace and API key were created: app.ontora.com uses US, while eu.ontora.com uses EU. API keys are region-bound.

​
Authentication

For programmatic integrations, use a workspace API key:
Keys are created and revoked in the dashboard under Developer → API Keys — key management is deliberately not part of the public API. Most endpoints also accept a Clerk JWT (Authorization: Bearer <token>), and the protected-corpus endpoints require a Confidential analysis key. See Authentication for scopes and rotation.

​
Versioning

The API is versioned in the path. The current stable version is v1 (US shown):
Breaking changes will go out under v2. Additive changes (new fields, new endpoints) ship in v1 without a version bump.

​
Changes and deprecations

​
October 2026: use_agentic_synthesis removed

Interview responses (InterviewOut) no longer include use_agentic_synthesis, and the field is no longer listed on InterviewCreate / InterviewUpdate. It has had no effect since September 2026: every campaign generates its report through the analyst report path, and responses always returned true. Requests that still send the field are accepted and the key is ignored. Clients that read it should treat a missing value as true.

​
Content types

  • Requests: application/json
  • Responses: application/json unless otherwise specified
  • Exports: text/markdown or application/zip

​
OpenAPI

The OpenAPI 3 spec for each regional API is available at:
The endpoint pages in this section are generated from that spec — they reflect the live API. The spec, and therefore this reference, covers Ontora’s supported public surface. Paths not listed here are internal contracts between Ontora’s own clients and the API; they may change or disappear without notice.

​
Errors

See Errors for the full list of status codes and error shapes.