Docs/API reference/API overview
API overview
REST over HTTPS, JSON in and out, X-API-Key auth, RFC 3339 timestamps, opaque string ids. Every endpoint is workspace-scoped by the key.
Base URL
text
https://api.idpforge.ai/v1Resources
| Resource | Description |
|---|---|
jobs | One submission to one pipeline. Owns processing status and stage traces. |
documents | The unit of extracted data. Owns lifecycle, lineage and the event ledger. |
pipelines | Read-only. Published versions and their stage shape. |
webhooks | Outbound event subscriptions with signed delivery. |
Errors
Errors return a consistent envelope. trace_id is safe to quote to support and appears in your workspace audit log.
json
{
"error": {
"code": "pipeline_not_published",
"message": "Pipeline std-invoice has no published version.",
"param": "pipeline_id",
"trace_id": "trc_4b91c0e2"
}
}Billing
Every job reserves credits when it is submitted and settles to what it used. A submission against an insufficient balance returns 402 Payment Required and creates no job. See Credits.
Pagination
List endpoints are cursor-paginated. Pass ?limit= (max 100) and ?after= with the last id from the previous page. Responses carry has_more.
Idempotency
Send an Idempotency-Key header on any POST. Replays within 24 hours return the original response rather than creating a second job.
Rate limits
| Environment | Limit | Burst |
|---|---|---|
| Sandbox | 60 req/min | 20 |
| Production | Per plan — 600 req/min on Growth and above | 100 |
Was this page helpful?
Last updated 19 Aug 2026