List Documents
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.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Datastore ID of the datastore to retrieve documents for
Query Parameters
Maximum number of documents to return
1 <= x <= 1000
Cursor from the previous call to list documents, used to retrieve the next set of results
Filters documents whose ingestion job status matches (one of) the provided status(es).
pending
, processing
, retrying
, completed
, failed
, cancelled
, failed_to_provision
, generating_data
, training_in_progress
, failed_to_generate_data
, provisioning
Filters documents uploaded at or after specified timestamp.
Filters documents uploaded at or before specified timestamp.
Response
Response body from GET /data/documents
List of documents retrieved based on the user's GET request
Document description
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 to continue pagination. Ommitted if there are no more documents after these ones, or if job_id was set in the request.
Was this page helpful?