Skip to content

Postman collection

Updated

Download#

Two files, from the client portal:

  • DocXtract_API.postman_collection.json — the requests
  • DocXtract_API.postman_environment.json — base_url, api_key, job_id

Both work in Postman and Bruno.

Setup#

  1. Import → drop both JSON files in
  2. Select the DocXtract API — Production environment
  3. Set api_key to your key from Settings (it is marked as a secret variable)
  4. Send Health check — it needs no auth, so it confirms connectivity on its own
  5. Send List document models — confirms your key works, and costs no credits
  6. On Extract structured data from a document, attach a file to the file form field and send

Steps 4 and 5 are free. Do them before spending a credit on an extraction.

What is included#

Six requests in three folders:

FolderRequests
ExtractionExtract structured data from a document
Multi-pageProcess one chunk, Collect the stitched result
DiscoveryList document models, Service health, Verify an API key

Each carries the documented response codes so you can see the error shapes without triggering them.

Generated from the spec#

The collection is generated from docs/openapi.yaml, the same contract that drives the interactive API reference. It cannot drift from the documented API.

Note
Do not hand-edit the collection and expect changes to survive. It is regenerated from the spec.

Multi-page requests#

The job_id environment variable is shared by the multi-page requests. A real run looks like:

  1. Send Extract with a PDF over 3 pages → you get 202 with a manifest, not a result
  2. Copy a chunk job_id from data[] into the job_id variable → send Process one chunk
  3. Repeat for every chunk
  4. Set job_id to the parent job_id from the manifest root → send Collect
Warning
The manifest contains two kinds of id. process takes a chunk job id from data[]; result takes the parent job id from the root. Mixing them up returns 404 job_not_found.

Doing this by hand is instructive but tedious — it is exactly what the SDKs automate.

When to use something else#

Instead useWhen
Test API pageYou want to see extraction quality on your own documents, with a copy-paste snippet
Interactive API referenceYou want to read the contract while trying calls
An SDKYou are past exploring and writing real code

Related