Skip to main content
POST
Stream a chat response from an agent (SSE)

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Agent identifier.

Body

application/json
message
string
required

User message to send to the agent.

Minimum string length: 1
history
object[]

Optional conversation history to seed the agent (additive on top of any persisted state).

conversationId
string

Existing conversation id to append onto. When omitted, a new conversation is created.

Response

text/event-stream payload. Each line is data: <json>\n\n. Terminal event includes final: true + conversation_id.

text/event-stream payload. Each line is data: <json>\n\n. Terminal event includes final: true + conversation_id.