API Reference
REST API surface for integrating with Dynamiq: deployed apps, runs, conversations, knowledge bases, and the AI gateway.
The Dynamiq REST API spans a few hosts, depending on what you're calling:
| Host | What lives there |
|---|---|
https://api.getdynamiq.ai | Management & observability: apps, traces, sessions, triggers, conversations, knowledge base management, document parse/extract |
https://<your-app-hostname> | Your deployed app's own endpoint: the Runs API and file uploads. Find the hostname on the app's Integration tab |
https://router.getdynamiq.ai | The AI Gateway OpenAI-compatible /v1/chat/completions |
https://collector.getdynamiq.ai | The trace collector for open-source SDK workflows |
Self-hosted deployments use their own hostnames — the paths and payloads are identical.
Response envelope
Management API responses wrap payloads in a data envelope; list endpoints add pagination:
{
"data": [{ "id": "…" }],
"pagination": { "page": 1, "page_size": 20, "page_count": 3, "total_count": 42 }
}Errors
Errors return a consistent shape with an HTTP status:
{
"error": { "code": "not_found", "message": "Not Found" }
}400— invalid request (validation errors on Go-served endpoints)401— missing or invalid key/token403— key valid but not allowed for this resource404— resource doesn't exist or is outside your key's scope422— validation errors on AI Gateway endpoints