GET
/
v1-preview
/
documents
from abbyy_document_ai import DocumentAi
import os


with DocumentAi(
    api_key_auth=os.getenv("DOCUMENTAI_API_KEY_AUTH", ""),
) as document_ai:

    res = document_ai.documents.list(cursor="xyz")

    while res is not None:
        # Handle items

        res = res.next()
[
  {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "image-to-text",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com

Query Parameters

​
cursor
string

The cursor to start the list from. If not provided, the list will start from the most recent documents.

​
limit
integer
default:10

The number of documents to return. The maximum allowed value is 25. If not provided, the list will return up to 10 documents.

Required range: 1 <= x <= 25

Response

200
application/json
Default Response
​
id
string
required

The id of the document.

​
name
string
required

The name of the document.

​
createdAt
string
required

Timestamp at which the document was created.

​
status
enum<string>
required

The status of the document. Valid values are Pending, Processing, Processed, Failed, Canceled.

Available options:
Pending,
Processing,
Processed,
Failed,
Canceled
​
pageCount
integer
required

The number of pages associated with the document that have been processed. This number will always be at least 1.

​
model
string

The model used to process the document.

​
errors
object[]

An array of errors that occurred while processing the document.

Was this page helpful?