BilbyHelp Center

Get stream

GET
/api/v1/conversations/{id}/stream

Observe the in-flight assistant stream for this conversation.

AI SDK UI Message Stream (SSE, x-vercel-ai-ui-message-stream: v1). Pass runId from the 202 admit response. Returns 204 when there is no live stream.

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

AI SDK UI Message Stream

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