Dynamiq
Conversations

Send a conversation message (SSE)

Sends a user message to a conversation and streams the assistant's response as Server-Sent Events. Each event is a JSON object with `id`, `type`, `sequence`, `timestamp`, and type-specific `data`; the stream ends after a terminal event (`run.completed`, `run.failed`, or `run.canceled`).

POST
/v3/conversations/{conversation_id}/messages

Authorization

AuthorizationBearer <token>

Organization or project Access Key created in the Dynamiq console. Used for deployed-app (Runs API), AI Gateway, traces collector, and management API requests. Send as Authorization: Bearer <access-key>.

In: header

Path Parameters

conversation_id*string

Conversation UUID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Body for POST /v3/conversations/{conversation_id}/messages.

Response Body

text/event-stream

application/json

application/json

application/json

curl -X POST "https://example.com/v3/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/messages" \  -H "Content-Type: application/json" \  -d '{    "model_id": "8e9f0a1b-2c3d-4e4f-8a5b-6c7d8e9f0a1b",    "content": [      {        "type": "text",        "text": "Summarize the duplicate-charge ticket and draft a reply."      },      {        "type": "file",        "file": {          "id": "0b54a6d2-9c1f-4f7e-8a36-2f6d1d2c9b11",          "name": "ticket-4812-screenshot.png"        }      }    ],    "subagents_enabled": false  }'
"event: agent.response.delta\ndata: {\"id\":\"a1b2...\",\"type\":\"agent.response.delta\",\"sequence\":4,\"timestamp\":\"2026-06-10T09:11:02Z\",\"data\":{\"object\":\"agent.response.delta\",\"delta\":\"The customer was charged twice\"}}\n\nevent: run.completed\ndata: {\"id\":\"b2c3...\",\"type\":\"run.completed\",\"sequence\":12,\"timestamp\":\"2026-06-10T09:11:09Z\",\"data\":{\"object\":\"run\",\"status\":\"completed\"}}\n"
{
  "error": {
    "code": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Delete a conversation

Permanently deletes a conversation and its messages.

Search knowledge base documents

Performs a semantic search over the knowledge base's documents using the knowledge base's configured embedder and retriever. Served on the knowledge base's own hostname (returned in the `hostname` field of the knowledge base resource).