{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "file_name": "document1.pdf",
      "file_size": 1048576,
      "created_at": "2024-03-21T13:45:00Z",
      "status": "COMPLETED",
      "accuracy": "ultra",
      "page_count": 10
    },
    {
      "id": "987fcdeb-a654-3210-9876-543210987654",
      "file_name": "document2.pdf",
      "file_size": 2097152,
      "created_at": "2024-03-21T13:45:00Z",
      "status": "PROCESSING",
      "accuracy": "lite",
      "page_count": null
    }
  ],
  "count": 150
}

​
List Documents

Retrieve a paginated list of your documents.

​
Request

​
Headers

​
Authorization
string
required

Bearer token authentication. See our Authentication guide for more details. Example: Bearer YOUR_API_KEY

​
Query Parameters

​
skip
integer
default:"0"

Number of records to skip for pagination

​
limit
integer
default:"100"

Maximum number of records to return

​
Example Request

curl https://api.doctly.ai/api/v1/documents/ \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

​
data
array

Array of document objects.

​
count
integer

Total number of documents available

​
Example Responses

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "file_name": "document1.pdf",
      "file_size": 1048576,
      "created_at": "2024-03-21T13:45:00Z",
      "status": "COMPLETED",
      "accuracy": "ultra",
      "page_count": 10
    },
    {
      "id": "987fcdeb-a654-3210-9876-543210987654",
      "file_name": "document2.pdf",
      "file_size": 2097152,
      "created_at": "2024-03-21T13:45:00Z",
      "status": "PROCESSING",
      "accuracy": "lite",
      "page_count": null
    }
  ],
  "count": 150
}