GET
/
brain
/
{brain_id}
/
documents
/
search

Authorizations

Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

brain_id
string
required

ID of the brain to search in

Query Parameters

search_query
string

Optional search query to filter documents

Response

200 - application/json
brain_id
string
required

A unique identifier for the “brain” associated with this document or data object

chunks
integer
required

The number of chunks the document or file has been split into, often for easier processing or handling.

created_at
string
required

The timestamp indicating when the document or file was created

document_id
string
required

A unique identifier for the document associated with this object

id
integer
required

An internal ID for this object

name
string
required

The name of the file or document

status
string
required

The current status of the document processing.

type
string
required

The type of the document or file

url
string
required

A URL link to access or download the file. This is likely a temporary signed URL from AWS S3, as it includes authentication details and an expiration timestamp

Create Text DocumentUpload Document