POST
/
v1-preview
/
models
/
packing-list
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.models.packing_list.begin_field_extraction(request={
        "input_source": {
            "url": "https://example.com/documents/invoice.png",
        },
    })

    assert res.documents is not None

    # Handle response
    print(res.documents)
[
  {
    "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

Body

application/json
Request to process a document using the packing-list model
​
inputSource
object
required

The source of the document(s) to be processed

Example:
{
  "url": "https://example.com/documents/invoice.png"
}

Response

201
application/json
​
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?