Skip to main content
POST
/
documents
/
get-document-info-list
Get Document Info List
curl --request POST \
  --url https://api.zeroentropy.dev/v1/documents/get-document-info-list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collection_name": "<string>",
  "limit": 1024,
  "path_prefix": "<string>",
  "path_gt": "<string>"
}
'
{
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "collection_name": "<string>",
      "path": "<string>",
      "metadata": {},
      "index_status": "not_parsed",
      "created_at": "2023-11-07T05:31:56Z",
      "size": 123,
      "num_pages": 123,
      "file_url": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The Authorization header must be provided in the format Bearer <your-api-key>.

You can get your API Key at the Dashboard!

Body

application/json
​
collection_name
string
required

The name of the collection.

​
limit
integer
default:1024

The maximum number of documents to return. This field is by default 1024, and cannot be set larger than 1024

​
path_prefix
string | null

All documents returned will have a path that starts with the provided path prefix.

​
path_gt
string | null

All documents returned will have a path strictly greater than the provided path_gt argument. (Comparison will be based on lexicographic comparison. It is guaranteed that two strings are lexicographically equal if and only if they have identical binary representations.).

Response

Successful Response

​
documents
DocumentMetadataResponse · object[]
required