Skip to content

Search

Global Search

Full-text search across chats and agents within an org.

status (chat lifecycle) and agent_id only apply to chat results; an agent match by name is returned regardless of chat status, and agent_id (searching within one already-known agent’s chats) suppresses agent-name results rather than filtering them.

Parameters

NameInTypeRequiredDescription
agent_idquerystring (uuid)noFilter results by agent
limitqueryintegernoMaximum results to return
offsetqueryintegernoPagination offset
org_idpathstring (uuid)yes
qquerystringyesSearch query text
statusqueryChatStatus[]noFilter results by chat status

Responses

StatusDescriptionBody
200Successful Responseagentdepot_api__routers__search__SearchResponse
422Validation ErrorHTTPValidationError