GET /public/beta/documents/{document_id}/ai-metadata

Returns the AI metadata fields populated for the document. Each result combines the field definition (id, key, field_type, settings) with the extracted value (value, acceptance_status).

Only fields that have an extracted value for the document are returned.

The endpoint signals AI extraction state via the HTTP status code:

202 extraction_pending — extraction is in progress. Clients should retry after the number of seconds indicated in the Retry-After header.
204 No Content — extraction has terminally failed for this document. No body is returned; retrying will not help — contact support.
409 not_started — extraction has not been triggered for this document (typically because the document is not yet completed).

Servers

https://api.pandadoc.com

Path parameters

Name	Type	Required	Description
`document_id`	String	Yes	The unique identifier of the document.

Query parameters

Name Type Required Description

Name	Type	Required	Description
`limit`	Integer	No	Maximum number of fields to return in one response. Default value: 100
`offset`	Integer	No	Number of fields to skip before starting to collect the result set. For predictable paging, use multiples of `limit`. Default value: 0

limit

Integer

Maximum number of fields to return in one response.

Default value: 100

offset

Integer

Number of fields to skip before starting to collect the result set. For predictable paging, use multiples of limit.

Default value: 0

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.