COcontextualai
/datastores/{id}/documents

List Documents

Changed on

Get list of documents in a given Datastore, including document id, name, and ingestion job status.

Performs cursor-based pagination if the number of documents exceeds the requested limit. The returned cursor can be passed to the next GET /datastores/{datastore_id}/documents call to retrieve the next set of documents.

get/datastores/{datastore_id}/documents

Request

  • Base URL
    https://api.contextual.ai/v1
  • URL
    https://api.contextual.ai/v1/datastores/{datastore_id}/documents
  • Auth
    HTTP bearer

Path parameters

datastore_idstring uuid required

Datastore ID of the datastore to retrieve documents for

Query parameters

limitinteger

Maximum number of documents to return

cursorstring

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

ingestion_job_statusDocumentStatusEnum[]

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

uploaded_afterstring date-time

Filters documents uploaded at or after specified timestamp.

uploaded_beforestring date-time

Filters documents uploaded at or before specified timestamp.

document_name_prefixstring

Filters documents with the given prefix.

document_name_searchstring

Filters documents whose name contains the search term (case-insensitive substring match).

Response

Successful Response

total_countinteger

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_cursorstring

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

Changes

  • 4abdda722de9Revision changes
    • breaking

      the // response's property type changed from object to no type for status

    • info

      added the new optional query request parameter document_name_search

  • c8152db45500Revision changes
    • breaking

      response property documents/items/custom_metadata/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 200