API reference
Protocol conventions and generated endpoint documentation.
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.comVersioned application endpoints live under /v1. Health and readiness probes
live at /healthz and /readyz.
Authentication
Authenticated endpoints accept either an engine API key or a tenant-signed JWT:
Authorization: Bearer <credential>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:
| Status | Meaning |
|---|---|
400 | Invalid request or validation failure |
401 | Missing or invalid authentication |
403 | Authenticated but not authorized |
404 | Resource not found or intentionally concealed |
402 | Insufficient credit |
409 | State conflict |
429 | Rate or concurrency limit |
503 | Required dependency unavailable |
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 compatibility, tenant,
organization, service, and platform-administration operations. Internal
browser-only /admin/api/* routes are intentionally omitted.
When an engine route changes, regenerate the reference:
cd developer-docs
bun run openapi:generatebun 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.