Skip to main content

qomplement API

The qomplement API lets you extract structured data from documents, fill PDF forms, and populate Excel templates — all programmatically. Upload a document and get back clean JSON with key-value pairs, tables, and entities detected by AI.

Base URL​

https://developer-api.qomplement.com/v1

All endpoints are prefixed with /v1. Include your API key in every request as a Bearer token.

Core Operations​

OperationEndpointDescription
ExtractPOST /v1/extractUpload documents in 30+ formats (PDF, images, Office docs) and extract structured data including key-value pairs, tables, and entities as clean JSON
Fill PDFPOST /v1/fill/pdfAutomatically fill PDF forms using source documents, natural language instructions, or explicit field mappings with intelligent field detection
Fill ExcelPOST /v1/fill/excelPopulate Excel templates with extracted document data, supporting multi-sheet workbooks and complex table layouts with smart column mapping
ModelsGET /v1/modelsRetrieve available AI models with details on capabilities, performance characteristics, pricing, and recommended use cases for your extraction tasks
FormatsGET /v1/formatsView the complete list of 30+ supported file types including PDF, DOCX, images (PNG, JPG, TIFF), spreadsheets, and presentations with format-specific capabilities
JobsGET /v1/jobs/{id}Check the status of asynchronous processing jobs with detailed progress information, results when complete, and error messages if failed
UsageGET /v1/usageAccess comprehensive API usage metrics including request counts, document processing statistics, model usage breakdown, and current billing period data

Supported File Types (30+)​

The API supports a wide range of file formats, with automatic detection:

  • Documents — PDF, DOCX, DOC, RTF, TXT, WPD
  • Spreadsheets — XLSX, XLSM, XLS, CSV, QPW
  • Presentations — PPTX, PPT
  • Images — PNG, JPG, JPEG, TIFF, BMP, GIF, HEIC, PSD, and more

All formats are supported natively. Use GET /v1/formats for the complete list.

Sync vs Async​

The API automatically decides whether to process synchronously or asynchronously:

  • Sync (returns 200 with result): Single file, 5 pages or fewer, no webhook
  • Async (returns 202 with job ID): Multiple files, more than 5 pages, or webhook requested

For async jobs, poll GET /v1/jobs/{id} until status is completed or failed.

Response Formats​

  • JSON (default) — Structured key-value pairs, tables, and entities
  • CSV — Tabular output
  • XML — XML-formatted output

Set the output_format parameter on the extract endpoint to choose.

Next Steps​