To understand how to implement Affinda into your existing tutorials, our Solution Design Tutorial walks through the range of common integration workflows for different use cases and requirements.
Design principles
- Few moving parts: A small set of REST resources (
/documents
,/document_types
,/workspaces
) covers the vast majority of use-cases. - Works straight away, yet customisable: Upload a PDF and retrieve JSON in a single call, or fine-tune behaviour with model versions, human-in-the-loop validation and post-processing rules.
- Document-agnostic by design: The same endpoint handles an invoice today and a payslip tomorrow; just swap the document type ID, not your integration.
- Observability built-in: Every response carries processing timestamps and confidence scores; webhook signatures let you verify payloads.
- Secure at scale: ISO-27001 compliant, API keys scoped per user, with regional endpoints to keep data where you need it.
Core primitives
Primitive | Purpose |
---|---|
Document | The file you upload (PDF, image, DOCX, etc.) plus its extracted data and metadata. |
Document Type | A model configuration that defines how a specific kind of document (invoice, résumé, passport, custom layout, …) is parsed. |
Workspace | Logical container that groups documents, permissions and webhook settings. |
Prerequisites
Before you make your first API call, you’ll need to:- Create an Affinda account and log in to the dashboard.
- Generate an API key (Settings → API Keys).
- Configure a document type (See our step-by-step tutorial on Creating a New Model).
- Retrieve the workspace identifier (Workspace → Workflow → Integrations).