REST API Reference (v1)5 min read• Updated October 2026
Agent Execution Endpoint (POST /v1/agents/{id}/run) (planned, not yet available)
Execute domain-specific AI analysis agents with structured schema responses.
Overview
PDFparse's public API, SDKs and webhooks are planned and not available yet; the examples below are previews of the intended design. Directly runs one of the 16 AI agents against an uploaded document. Consumes 1 credit per execution.
Parameters & Response Codes
| Parameter / Code | Type | Required | Description |
|---|---|---|---|
| agent_id | Path string | Required | Unique agent slug: 'invoice-auditor', 'bank-statement-detector', 'contract-analyzer', etc. |
| file | Binary / Form | Required | Document stream. |
| exportFormat | string | Optional | Return format: 'json' (default), 'tsv', or 'xlsx'. |
Sample Output Payload (JSON Schema)
Standard Output FormatZero Hallucinations Verified
{
"status": "success",
"executionId": "exec_918204",
"agent": "invoice-auditor",
"creditsDeducted": 1,
"remainingCredits": 4,
"data": { ... }
}