BilbyHelp Center

List conversations

GET
/api/v1/conversations

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.

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
page?integer
Range0 < value <= 9007199254740991
limit?integer
Range0 < value <= 100

Response Body

Paginated conversations for the effective organization

application/json
  1. response
items*array<>
nextCursor*number|null
hasMore*boolean
total*number
page*number
limit*number
Example Request
curl -X GET 'https://pulse.bilby.ai/api/v1/conversations' \  -H 'Authorization: Bearer YOUR_API_KEY'
Example Response
{  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "userId": "string",      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",      "title": "string",      "activeRunId": "string",      "activeMessageId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": 0,  "hasMore": true,  "total": 0,  "page": 0,  "limit": 0}