Chat with the Agent over project knowledge

Multi-turn conversational endpoint. Supports both synchronous JSON responses and server-sent event (SSE) streaming via stream: true.

Authentication

AuthorizationBearer

Pyramid API key (prefix with “Bearer ”)

Request

This endpoint expects an object.
messageslist of objectsRequired
project_idstringOptionalformat: "uuid"
chat_idstringOptionalformat: "uuid"
chat_typeenumOptional
Allowed values:
modelenumOptional
Allowed values:
streambooleanOptionalDefaults to false

Response

Chat response (JSON when stream=false, SSE when stream=true)

request_idstringformat: "uuid"

Server-generated per-request UUID. Also sent as X-Request-Id response header. Include in support tickets.

successany
dataobject
paginationobject

Present only on list endpoints. Top-level (not nested inside data).

Errors

400
Bad Request Error
401
Unauthorized Error