Skip to main content

Submit for Processing

Submit a document against a named processing configuration and have results delivered via webhook. Idempotent per (config, batch, file).

The process endpoint is the named-operations front door: upload a document, name the processing configuration to run it through, and get results delivered asynchronously via the process.completed webhook. It always returns immediately (202 Accepted) with a run_id and a poll_url, so you never block on the pipeline.

Idempotency is automatic. The same (config_id, batch_id, file) combination returns the existing run instead of re-processing, so a retried upload is safe. If batch_id is absent, dedup applies within a 24-hour window. This makes the endpoint robust for at-least-once delivery from upstream systems.

This surface uses the operations scope. Configure the processing configurations (and discover their IDs) with GET /v1/configs.
POST/v1/process

Response

Response fields (202)

request_idstringIdentifier for this submission.
run_idstringThe run UUID to poll.
config_idstringThe configuration used.
statusstringprocessing.
poll_urlstringURL to poll for the run result.
A 200 (instead of 202) means an idempotency hit — the existing run result is returned without re-processing.