Dynamiq

Dynamiq Platform API

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.

GitHub OpenAPI

Operations 14

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) #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/getdynamiq/refs/heads/main/openapi/_ae-authored/getdynamiq-platform-openapi-generated.yml

Schemas & Data

📊
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/getdynamiq:platform-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

getdynamiq-platform-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Dynamiq Platform API
  version: '2026-10-20'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-20: 14 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Dynamiq has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 9
    documentation: 8
    pages-with-code: 10
    pages-read: 10
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-20'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.getdynamiq.ai/docs/platform/deployments/run-api
  x-docs-section: platform
servers:
- url: https://api.getdynamiq.ai
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Python TypeScript curl \"https://<your-app-hostname>/v1/runs?status=awaiting_input&user_id=user-42\"  -H \"Authorization:\
          \ Bearer $DYNAMIQ_ACCESS_KEY \" import os \n import requests \n endpoint = \"https://<your-app-hostname>\" \n headers = { \"Authorization\"\
          \ : f \"Bearer { os.getenv( 'DYNAMIQ_ACCESS_KEY' ) } \" } \n response = requests.get( f \" {endpoint} /v1/runs\" , headers = headers,\
          \ \n params = { \"statu"
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Python TypeScript curl -X POST \"https://<your-app-hostname>/v1/runs\"  -H \"Authorization: Bearer $DYNAMIQ_ACCESS_KEY\
          \ \"  -H \"Content-Type: application/json\"  -d '{\"input\": {\"question\": \"What can you do?\"}}' import os \n import requests \n\
          \ endpoint = \"https://<your-app-hostname>\" \n headers = { \"Authorization\" : f \"Bearer { os.getenv( 'DYNAMIQ_ACCESS_KEY' ) } \"\
          \ } \n response = requests.post( f \" {en"
  /v1/apps:
    get:
      operationId: get_v1_apps
      tags:
      - Apps
      summary: GET /v1/apps
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl "https://api.getdynamiq.ai/v1/apps/ $APP_ID /traces/ $TRACE_ID "  -H "Authorization: Bearer $DYNAMIQ_PAT " '
  /v1/apps/:
    get:
      operationId: get_v1_apps
      tags:
      - Apps
      summary: List apps
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1AppsResponse'
      x-evidence:
        kind: documentation
  /v1/apps/{appId}/traces:
    get:
      operationId: get_v1_apps_appId_traces
      tags:
      - Apps
      summary: List traces for an app
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1AppsAppidTracesResponse'
      x-evidence:
        kind: documentation
  /v1/files:
    post:
      operationId: post_v1_files
      tags:
      - Files
      summary: Upload a file for later runs
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1FilesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1FilesResponse'
      x-evidence:
        kind: documentation
  /v1/runs:
    get:
      operationId: get_v1_runs
      tags:
      - Runs
      summary: List runs
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      parameters:
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: Filter by status (repeatable)
      - name: user_id
        in: query
        required: false
        schema:
          type: string
        description: Only runs created with this user_id
      - name: session_id
        in: query
        required: false
        schema:
          type: string
        description: Only runs in this session (UUID)
      - name: page
        in: query
        required: false
        schema:
          type: integer
        description: Page number, starting at 1
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
        description: Items per page
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1RunsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_runs
      tags:
      - Runs
      summary: Create a run (sync, streaming, or background)
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1RunsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1RunsResponse'
      x-evidence:
        kind: documentation
  /v1/runs/:
    get:
      operationId: get_v1_runs
      tags:
      - Runs
      summary: List runs (duplicate endpoint)
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1RunsResponse2'
      x-evidence:
        kind: documentation
  /v1/runs/{runId}:
    get:
      operationId: get_v1_runs_runId
      tags:
      - Runs
      summary: Get one run
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      parameters:
      - name: runId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1RunsRunidResponse'
      x-evidence:
        kind: documentation
  /v1/runs/{runId}/cancel:
    post:
      operationId: post_v1_runs_runId_cancel
      tags:
      - Runs
      summary: Cancel a run
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      parameters:
      - name: runId
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1RunsRunidCancelResponse'
      x-evidence:
        kind: documentation
  /v1/runs/{runId}/events:
    get:
      operationId: get_v1_runs_runId_events
      tags:
      - Runs
      summary: List a run's stored events
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      parameters:
      - name: runId
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: integer
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1RunsRunidEventsResponse'
      x-evidence:
        kind: documentation
  /v1/runs/{runId}/input:
    post:
      operationId: post_v1_runs_runId_input
      tags:
      - Runs
      summary: Send human-in-the-loop input to a run
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      parameters:
      - name: runId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1RunsRunidInputRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1RunsRunidInputResponse'
      x-evidence:
        kind: documentation
  /v1/runs/{runId}/stream:
    get:
      operationId: get_v1_runs_runId_stream
      tags:
      - Runs
      summary: Stream a run's events over Server‑Sent Events (SSE)
      x-source: https://docs.getdynamiq.ai/docs/platform/deployments/run-api
      parameters:
      - name: runId
        in: path
        required: true
        schema:
          type: string
      - name: after_sequence
        in: query
        required: false
        schema:
          type: integer
        description: Resume after this sequence number (minimum 1)
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1RunsRunidStreamResponse'
      x-evidence:
        kind: documentation
security:
- bearer: []
components:
  schemas:
    GetResponse:
      type: object
      properties:
        status:
          type: string
        user_id:
          type: string
    PostRequest:
      type: object
      properties:
        input:
          type: object
          properties:
            question:
              type: string
    PostResponse:
      type: object
      properties:
        input:
          type: object
          properties:
            question:
              type: string
    GetV1AppsResponse:
      type: object
      properties:
        data:
          type: array
          description: App objects
    GetV1AppsAppidTracesResponse:
      type: object
      properties:
        data:
          type: array
          description: Trace objects
    PostV1FilesRequest:
      type: object
      properties:
        file:
          type: string
          description: File part in multipart/form-data
      required:
      - file
    PostV1FilesResponse:
      type: object
      properties:
        data.id:
          type: string
        data.name:
          type: string
        data.size:
          type: integer
        data.mime_type:
          type: string
    GetV1RunsResponse:
      type: object
      properties:
        data:
          type: array
          description: List of run objects
        pagination.page:
          type: integer
        pagination.page_size:
          type: integer
        pagination.page_count:
          type: integer
        pagination.total_count:
          type: integer
    PostV1RunsRequest:
      type: object
      properties:
        input:
          type: object
          description: Workflow input – keys match your workflow's Input node fields
        stream:
          type: boolean
          description: true returns the run as a Server‑Sent Events stream
        background:
          type: boolean
          description: true returns 202 immediately with the run id
        file_ids:
          type: array
          description: IDs of files previously uploaded via POST /v1/files
        user_id:
          type: string
          description: Your identifier for the end user
        session_id:
          type: string
          description: Conversation session ID (UUID)
      required:
      - input
    PostV1RunsResponse:
      type: object
      properties:
        data.id:
          type: string
        data.app_id:
          type: string
        data.status:
          type: string
        data.input:
          type: object
        data.output:
          type: object
        data.started_at:
          type: string
        data.ended_at:
          type: string
        data.trace_id:
          type: string
    GetV1RunsResponse2:
      type: object
      properties:
        data:
          type: array
          description: Run objects
    GetV1RunsRunidResponse:
      type: object
      properties:
        data.id:
          type: string
        data.status:
          type: string
        data.started_at:
          type: string
        data.input:
          type: object
        data.input_requests:
          type: array
    PostV1RunsRunidCancelResponse:
      type: object
      properties:
        status:
          type: integer
          description: 200 on success
    GetV1RunsRunidEventsResponse:
      type: object
      properties:
        data:
          type: array
          description: Stored event objects
        pagination:
          type: object
    PostV1RunsRunidInputRequest:
      type: object
      properties:
        type:
          type: string
          description: One of human_feedback, approval_request.confirmed, approval_request.rejected
        data:
          type: object
          description: Depends on type; includes request_id and other fields
      required:
      - type
      - data
    PostV1RunsRunidInputResponse:
      type: object
      properties:
        status:
          type: integer
          description: 200 on success
    GetV1RunsRunidStreamResponse:
      type: object
      properties:
        event:
          type: object
          description: SSE event with id, type, sequence, timestamp, data
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: Api
- name: Apps
- name: Files
- name: Runs