Search Conversations
Search conversations for an organization. Access scoping: - JWT users see their own user-scoped + all org-scoped conversations. - API keys see only org-scoped conversations.
Authorization
BearerAuth Botyard API key — see /docs/authentication.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body for searching / listing conversations.
Response Body
application/json
curl -X POST "https://example.com/v1/orgs/string/conversations/search" \ -H "Content-Type: application/json" \ -d '{}'{
"items": [
{
"conversation_id": "string",
"org_id": "string",
"bot_id": "string",
"user_id": "string",
"owner_name": "string",
"conversation_scope": "user",
"source": "web_chat",
"title": "string",
"status": "active",
"metadata": {
"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_message_at": "2019-08-24T14:15:22Z",
"unread_count": 0,
"is_pinned": false,
"pin_position": 0,
"has_active_timed_wake": false,
"has_active_process_watch": false,
"supports_steering": true,
"message_search_match": {
"message_id": "string",
"message_ordinal": 0,
"snippet": "string",
"score": 0
}
}
],
"total": 0,
"limit": 0,
"offset": 0,
"has_more": true
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"error_code": "string",
"errors": [
{
"pointer": "string",
"detail": "string",
"type": "string"
}
],
"trace_id": "string"
}Create Conversation
Create a new conversation. Scope is derived from the auth context when not provided: - JWT users default to ``user`` scope (conversation owned by the caller). - API keys default to ``org`` scope (org-wide conversation).
List currently streaming conversations visible to the caller
Return active streaming turns visible to the caller. Workforce boards, chat surfaces, and other aggregate views need a cold-start snapshot of which conversations are currently streaming. The chat message list exposes this per conversation; this bulk endpoint applies the same lease TTL and conversation visibility rules. With ``all_visible=True`` the caller gets every active turn it can see and filters locally — preferred for the chat polls, which watch an unbounded number of conversations but only ever see a small set of live streams. Otherwise the result is narrowed to the requested ``conversation_ids`` and/or ``bot_slugs`` (OR-combined).