/search

Authorization

string

required

Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your organization’s API key.

projectId

string

required

The project ID to perform the search on. This is displayed in the “Project Details” card on the project page.

searchQuery

string

required

The search query string. For example, “companies that require HIPAA compliance”

numberOfBatches

integer

required

The number of batches of synthetic data to generate for the search. This parameter may range from 10 to 70. Increasing this may improve search quality but will increase response time.

topK

integer

required

The maximum number of results to return. This parameter may range from 1 to Infinity. Changing this parameter will not affect search time.

filterQuery

string

The filter query string which enables you to filter the search results using the filter columns in the dataset. Learn more about filter queries here.

data

object

success

true

This field is always true if the search was successful.

error

null

This field is always null if the search was successful.

data

null

This field is always null if the search was not successful.

success

false

Indicates the search was not successful.

error

object

An error object containing the error message and code.

code

error_code

The error code. Refer to the table below for possible error codes.

Error Code	Description
`invalid_json`	The request body is not valid JSON.
`invalid_request_body`	The request body schema did not match the expected schema.
`internal_server_error`	An internal server error occurred. Please contact support.
`no_bearer_token`	The request is missing the `Authorization` header.
`invalid_bearer_token`	The API key is invalid.
`filter_columns_not_found`	The filter query attempted to filter on a column that does not exist.
`filter_query_error`	The filter query is not valid. Learn more about filter queries here.
`dataset_embedding_not_found`	The dataset uploaded is missing the ‘embedding’ column.
`dataset_tag_not_found`	The dataset uploaded is missing the ‘tag’ column.
`dataset_empty`	The dataset uploaded is empty.
`invalid_top_k`	The top K is not valid. It must be an integer between 1 and Infinity.
`invalid_number_of_batches`	The number of batches is not valid. It must be an integer between 10 and 70.
`invalid_search_query`	The search query is invalid. It must be a non-empty string.

message

string

The error message explaining the error in detail.

API Reference

Header

Body

Success Response

Error Response

API Reference

​Header

​Body

​Success Response

​Error Response

Header

Body

Success Response

Error Response