Quickstart
Create a key. Parse a PDF with one curl call.
This page takes you from an API key to a parsed file. You need curl and the admin role in your organization.
Create an API key
Open API keys in Dash and select Create key. Select the Test environment and the parse scope. Dash shows the value of the new key. Copy it.
Test keys have their own rate limits, but their jobs use real paperwork credits.
Parse a file
Prefer: wait=30 holds the request for up to 30 seconds. The call below reads a public form from a URL.
If the job finishes in time, the answer is 200 with the finished job:
The result is in output.output. Read Jobs for the two output forms.
Next steps
- Get the result in the background: Webhooks.
- Follow the progress of a job: Streaming.
- Retry safely: Idempotency.