Skip to content

Search across collections

POST
/voice/collections/search

SPENDS NOTHING billable. Vector search over the named collections, best match first. Ids that are not this organisation’s are skipped by voice; if none remain it is a 404.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Voice CollectionSearchRequest, without org_id.

object
collection_ids
required

Collections to search (1-4 is best).

Array<integer>
>= 1 items <= 20 items
query
required
string
>= 1 characters
top_k

Results per collection.

integer
default: 15 >= 1 <= 100

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string