Skip to main content
POST
/
v1
/
ai-invoice-parser
AI Invoice Parser
curl --request POST \
  --url https://api.pdf.co/v1/ai-invoice-parser \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/document-parser/sample-invoice.pdf",
  "customfield": "<string>",
  "callback": "https://example.com/callback/url/you/provided"
}
'
{
  "status": "success",
  "message": "Success",
  "url": "https://pdf-temp-files.s3.us-west-2.amazonaws.com/output.pdf",
  "jobId": "6YSZD3U872ZYYFEDMQCQSGEEO8YSF5WA",
  "credits": 2,
  "remainingCredits": 1480582,
  "duration": 33
}

​
Prerequisites

Before using the AI Invoice Parser API, please note:
  • Invoices only: The API processes invoices exclusively to ensure accurate parsing.
  • Asynchronous processing: When you make a request, you get a JobID immediately while processing happens in the background.
To get your results, you can either:
  • Poll the job/check endpoint using your JobID, or
  • Provide a callback URL to get results automatically via webhook.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string<uri>
default:https://pdfco-test-files.s3.us-west-2.amazonaws.com/document-parser/sample-invoice.pdf
required

URL to the source file url attribute.

​
customfield
string

JSON string containing custom field names to extract. Use camelCase for field names (e.g., storeNumber, deliveryDate). Multiple fields should be comma-separated.

​
callback
string<uri>
default:https://example.com/callback/url/you/provided

The callback URL (or Webhook) used to receive the POST data. see Webhooks & Callbacks. This is only applicable when async is set to true.

Response

Success.

​
status
string

Status of the API response.

Example:

"success"

​
message
string

Descriptive message for the response status.

Example:

"Success"

​
url
string<uri>

URL to the output file.

Example:

"https://pdf-temp-files.s3.us-west-2.amazonaws.com/output.pdf"

​
jobId
string

Unique identifier for the job.

Example:

"6YSZD3U872ZYYFEDMQCQSGEEO8YSF5WA"

​
credits
integer

Credits used for this operation.

Example:

2

​
remainingCredits
integer

Credits remaining after this operation.

Example:

1480582

​
duration
integer

Time taken to complete the request, in milliseconds.

Example:

33