Getting started / Introduction

DocMind API

DocMind turns any document — invoices, receipts, contracts, IDs — into structured, typed JSON with a single API call. Define a template once, then extract from thousands of documents.

What is DocMind

DocMind is a document-intelligence API. You send a document and a template that describes the fields you want, and DocMind returns clean, typed JSON. Extraction runs on large language models with schema-constrained outputs, so every response matches the shape you defined — no brittle regex or per-vendor parsers.

How it works

Every integration follows the same three steps:

Create a template — name the fields you want and their types (string, number, date, boolean, object for JSON maps, or array for repeating rows).
Submit a document — POST a file URL or base64 payload to /v1/extract. The call returns immediately with a job id.
Read the result — poll /v1/extractions/{id} or receive a webhook when the extraction completes.

cURL

curl https://api.docmind.wistfare.com/v1/extract \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "9f2a3c91-7d94-4401-94fe-cfbd6fed63f9",
    "file_url": "https://example.com/invoice.pdf"
  }'

Asynchronous by designExtraction is processed by a background worker so large documents never block your request. You get a 202 Accepted with a job id, then collect the result by polling or webhook.

Key concepts

Organization — your workspace. Every key, template, and extraction is fully isolated to it.
Template — a reusable set of fields plus an optional prompt that guides extraction.
Extraction — one run of a template against one document, with its status and structured result.
Credits — usage is metered internally and debited from your balance at your organization’s customer rate. Top up with Mobile Money.
API key — a secret (sk_live_… / sk_test_…) that authenticates requests.

Next steps

Ready to build? Start with the Quickstart to make your first extraction in a few minutes, then read about Authentication and Templates.

NextQuickstart