# Dynamiq Platform API

**Canonical:** https://apis.io/apis/getdynamiq/platform-api/  
**Provider:** Dynamiq — https://apis.io/providers/getdynamiq/  
**Base URL:** https://api.getdynamiq.ai  
**Documentation:** https://docs.getdynamiq.ai/docs/platform

Dynamiq Platform API is one of 2 APIs that [Dynamiq](https://apis.io/providers/getdynamiq/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Dynamiq Platform API as documented publicly: 14 operations. Contract generated from the documentation by API Evangelist (2026-10-20); not the provider's own document.

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | GET / |
| POST | `/` | POST / |
| GET | `/v1/apps` | GET /v1/apps |
| GET | `/v1/apps/` | List apps |
| GET | `/v1/apps/{appId}/traces` | List traces for an app |
| POST | `/v1/files` | Upload a file for later runs |
| GET | `/v1/runs` | List runs |
| POST | `/v1/runs` | Create a run (sync, streaming, or background) |
| GET | `/v1/runs/` | List runs (duplicate endpoint) |
| GET | `/v1/runs/{runId}` | Get one run |
| POST | `/v1/runs/{runId}/cancel` | Cancel a run |
| GET | `/v1/runs/{runId}/events` | List a run's stored events |
| POST | `/v1/runs/{runId}/input` | Send human-in-the-loop input to a run |
| GET | `/v1/runs/{runId}/stream` | Stream a run's events over Server‑Sent Events (SSE) |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/getdynamiq/refs/heads/main/openapi/_ae-authored/getdynamiq-platform-openapi-generated.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/getdynamiq/refs/heads/main/json-schema/getdynamiq-post-v1-runs-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/getdynamiq/refs/heads/main/json-schema/getdynamiq-post-v1-runs-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/getdynamiq/refs/heads/main/json-schema/getdynamiq-post-v1-runs-runid-input-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/getdynamiq/refs/heads/main/json-schema/getdynamiq-get-v1-runs-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/getdynamiq/refs/heads/main/json-schema/getdynamiq-get-v1-runs-runid-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/getdynamiq/refs/heads/main/json-schema/getdynamiq-post-v1-files-response-schema.json

## Other Dynamiq APIs (1)

- [Dynamiq API Reference API](https://apis.io/apis/getdynamiq/api-reference-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/getdynamiq/platform-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/getdynamiq/.