GET
/
datastores
/
{datastore_id}
/
documents
List Documents
curl --request GET \
  --url https://api.contextual.ai/v1/datastores/{datastore_id}/documents \
  --header 'Authorization: Bearer <token>'
{
  "total_count": 123,
  "next_cursor": "<string>",
  "documents": [
    {
      "custom_metadata": {},
      "custom_metadata_config": {},
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "pending",
      "created_at": "<string>",
      "updated_at": "<string>",
      "ingestion_config": {},
      "has_access": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
datastore_id
string<uuid>
required

Datastore ID of the datastore to retrieve documents for

Query Parameters

​
limit
integer
default:1000

Maximum number of documents to return

Required range: 1 <= x <= 1000
​
cursor
string

Cursor from the previous call to list documents, used to retrieve the next set of results

​
ingestion_job_status
enum<string>[]

Filters documents whose ingestion job status matches (one of) the provided status(es).

​
uploaded_after
string<date-time>

Filters documents uploaded at or after specified timestamp.

​
uploaded_before
string<date-time>

Filters documents uploaded at or before specified timestamp.

​
document_name_prefix
string

Filters documents with the given prefix.

Response

Successful Response

Response body from GET /data/documents

​
documents
DocumentDescription · object[]
required

List of documents retrieved based on the user's GET request

​
total_count
integer

Total number of available documents which would be returned by the request if no limit were specified. Ommitted if job_id was set in the request.

​
next_cursor
string

Next cursor to continue pagination. Ommitted if there are no more documents after these ones, or if job_id was set in the request.