List documents¶
GET /document-intelligence/v1/collections/{collection_id}/documents
The documents in a collection, a page at a time, newest first. Each entry carries its processing status and a download link.
Parameters¶
| Name | In | Required | Notes |
|---|---|---|---|
collection_id |
path | yes | - |
page |
query | no | defaults to 1 |
page_size |
query | no | defaults to 20 |
sort |
query | no | defaults to created_at |
order |
query | no | defaults to desc |
name |
query | no | - |
Example¶
curl -X GET "https://api.futuresmart.ai/document-intelligence/v1/collections/{collection_id}/documents" \
-H "Authorization: Bearer $FS_API_KEY"
Responses¶
200
| Field | Type | Required | Notes |
|---|---|---|---|
documents |
array of DocumentOut | yes | - |
total_count |
integer | yes | - |
page |
integer | yes | - |
page_size |
integer | yes | - |
total_pages |
integer | yes | - |
Every failure, a malformed request included, comes back in the shared envelope with a stable code to branch on. See Errors.