API Overview

/api/v1 is the canonical API boundary for the Onyx app, CLI, and external integrations.

Authentication

API requests use bearer authentication:

curl https://app.onyxresearch.ai/api/v1/me \
  -H "Authorization: Bearer $ONYX_API_KEY"

Browser app requests can also authenticate with the WorkOS session cookie.

Successful responses use:

{
  "data": {}
}

Errors use:

{
  "error": {
    "code": "bad_request",
    "message": "Readable error message",
    "details": {}
  }
}

Projects, campaigns, experiments, graphs, timelines, explicit reconciliation, files, blobs, diffs, and repository sync.

GitHub App installations and repositories available to a team.

Current user, teams, and license information.

Team-scoped user keys, rotation, and revocation.

The checked-in OpenAPI artifact lives at:

reference/openapi.json

Regenerate it from the product repo with:

node scripts/sync-openapi.mjs