BilbyHelp Center
Open Bilby

Get conversation

GET
/api/v1/conversations/{id}

Conversation metadata plus active-branch messages.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Personal API key (Authorization: Bearer pulse_...). Scoped to selected organizations (or all current ones); acts as the creating user. If the key covers more than one organization, pass its organizationId on each request.

Path Parameters

id*string

Query Parameters

organizationId?string

Organization to operate in. Optional when the API key is bound to exactly one organization (inferred). Required for keys that cover several or all organizations, and for session cookie auth.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
workspaceId?stringDeprecated

Deprecated: the old name of organizationId, still accepted. If both are sent, they must match.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
runId?string
cursor?string

Response Body

Conversation with active-branch messages

Example Request
curl -X GET 'https://pulse.bilby.ai/api/v1/conversations/string' \  -H 'Authorization: Bearer YOUR_API_KEY'
Example Response
Empty

Create conversation POST

Create a conversation. With no `message`: **201** and the conversation row. With `message`: **202** `{ runId, streamUrl }` — observe with Get stream.

Send message POST

Append a user message and admit an assistant turn. Body is `{ message, attachments?, locale?, reasoningEffort? }`. History is server-side. Returns **202** `{ runId, streamUrl }`. Observe with Get stream.