Conversation Service
Send a message to the App and get the Supervisor's synthesized reply. The Supervisor routes work to the App's member Agents and Flows (at their pinned published versions) and answers with one voice.
Multi-turn: pass the returned conversation_id on subsequent calls -- prior turns are restored server-side, so never resend history. Set stream: true for a Server-Sent Events response instead of a single JSON reply.
Each call runs and bills as one execution against your organization's credits.
Requires the apps:execute scope.
Authorization
apiKey An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).
In: header
Path Parameters
The App's id (see GET /apps).
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/conversation" \ -H "Content-Type: application/json" \ -d '{ "message": "string" }'{ "reply": "string", "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407", "greeting": "string"}