API primitives

Base URL & Auth

  • Auth: Include the header Authorization: Bearer <api_key> or use our clients.
  • Roles: globally permissioned admin vs single customer scoped keys
  • Identity Check: GET /v1/whoami
  • Health Check: GET /v1/health

Endpoint map

  • Ingest: POST /v1/media · GET /v1/media/formats · GET /v1/jobs/{job_id} · POST /v1/jobs/{job_id}/cancel
  • Read: GET /v1/media/{blob_id} · /bytes · /frames · /transcript
  • Search: POST /v1/search - text or image
  • Duplicates: GET /v1/duplicates/suggested-threshold · POST /v1/duplicates
  • SQL console: POST /v1/query
  • Keys: POST /v1/keys · GET /v1/keys · POST /v1/keys/{key_id}/revoke
  • Export / Import: POST /v1/export · POST /v1/import
  • Maintenance: POST /v1/customers/reassign-bulk · GET /v1/corpus

Conventions

  • Async by default. Ingest supports one or many items at will.
  • Errors: 401 missing/bad key · 403 role/scope violation · 400 bad query/SQL · 404 unknown blob/job · 422 validation · 429 rate limited · 504 SQL timeout
  • OpenAPI spec is live here: GET /openapi.json which you can interact with for more documentation or to generate your own clients.

See It Working