API reference

The Deeplinq HTTP API uses JSON request and response bodies, except for file uploads, streamed responses, and export endpoints.

Base URL

Examples use:

https://api.example.com

Versioned application endpoints live under /v1. Health and readiness probes live at /healthz and /readyz.

Authentication

Authenticated endpoints accept an OAuth2 access token from the platform identity provider — a machine token for a tenant's backend, an end-user token for a person:

Authorization: Bearer <access token>

Errors

Failures use an HTTP status appropriate to the category. OpenAI- and Anthropic-compatible routes translate failures into their respective error envelopes; native Deeplinq routes use the engine's typed JSON error shape.

Common statuses include:

Generated endpoints

The endpoint pages in this section provide a complete inventory of the registered engine API. openapi/deeplinq.yaml is generated directly from the production Go route registrations, including method, path, path-parameter format, authority class, source file, and the detailed compatibility-protocol schemas. Native feature operations whose request and response DTOs are not yet machine-derived are explicitly rendered as open JSON objects; use the linked task guide and handler source for their field contract. Internal browser-only /admin/api/* routes are intentionally omitted.

When an engine route changes, regenerate the reference:

cd developer-docs
bun run openapi:generate

bun run check fails when the generated specification is stale. Use the API surface for a compact capability-oriented overview and the task guides for end-to-end examples.