Skip to main content

​
Base URL

Partner endpoints live under a separate prefix:

​
Authentication

Public API endpoints (/v1/public/...) use bearer authentication with an Everbility API key:
Ask an organisation admin to enable API keys for your organisation. They can email support@everbility.com to enable API keys and/or create a test account. Partner endpoints (/v1/partner/...) use OAuth 2.0 access tokens issued by POST /v1/partner/oauth/token instead of API keys. See Partner integration for the connect flow.

​
Response patterns

  • Synchronous endpoints return JSON.
  • PDF uploads, large-audio uploads, and report generation return a job_id and complete asynchronously.
  • Poll GET /jobs/{job_id} until the job reaches completed or failed.

​
Machine-readable schema

You can also fetch the raw OpenAPI schema from:
Import this URL directly into Postman or another OpenAPI-compatible client. The schema is hosted on the public documentation site; the API-hosted /v1/public/openapi.json endpoint requires authentication. Use the navigation on this tab to explore each endpoint in detail.