Skip to main content
Search documents

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Body

application/json
query
string
required
Required string length: 1 - 4000
mode
enum<string>
default:ranked
Available options:
ranked,
exact
document_ids
string<uuid>[]
Required array length: 1 - 500 elements
agreement_ids
string<uuid>[]
Required array length: 1 - 100 elements
limit
integer

Passages to return: ranked defaults to 5, exact to 20 per document.

Required range: 1 <= x <= 50

Response

Relevant passages and the documents that could not be searched.

mode
enum<string>
required
Available options:
ranked
passages
object[]
required
unavailable_documents
object[]
required