aid: affinda url: https://raw.githubusercontent.com/api-evangelist/affinda/refs/heads/main/apis.yml apis: - aid: affinda:affinda-documents-api name: Affinda Documents API tags: - Document Processing - Document Extraction - AI - OCR humanURL: https://docs.affinda.com/reference/getting-started properties: - url: https://docs.affinda.com/reference/getting-started type: Documentation - url: openapi/affinda-documents-api-openapi.yml type: OpenAPI - url: json-schema/affinda-document-schema.json type: JSONSchema - url: json-ld/affinda-context.jsonld type: JSONLD description: >- Upload documents (PDF, images, DOCX, XLSX, TXT, HTML) and Affinda returns structured JSON extraction with confidence scores, bounding boxes, and OCR text. Supports invoices, resumes, receipts, contracts, passports, and custom document types. 20 MB file size limit (5 MB for resumes), 20 pages default. Returns parsing status, raw text, parsed fields, and original file references. - aid: affinda:affinda-document-types-api name: Affinda Document Types API tags: - Document Processing - Document Types - Models - Configuration humanURL: https://docs.affinda.com/reference/document-types properties: - url: https://docs.affinda.com/reference/document-types type: Documentation - url: openapi/affinda-document-types-api-openapi.yml type: OpenAPI description: >- Manage document type definitions — the model configuration governing how a specific document category (invoice, resume, custom contract) is parsed. Each document type exposes a JSON Schema and optional Pydantic model representation. Document types are configured in the dashboard or natural-language workflow builder and reused across workspaces and collections. - aid: affinda:affinda-workspaces-api name: Affinda Workspaces API tags: - Workspaces - Organization - Permissions humanURL: https://docs.affinda.com/reference/workspaces properties: - url: https://docs.affinda.com/reference/workspaces type: Documentation - url: openapi/affinda-workspaces-api-openapi.yml type: OpenAPI description: >- Workspaces group together related collections, documents, members, and webhook subscriptions. Workspace identifiers scope every document upload, listing, and webhook delivery. Includes per-workspace usage reporting for credits and pages processed. - aid: affinda:affinda-organizations-api name: Affinda Organizations API tags: - Organization - Administration - Account humanURL: https://docs.affinda.com/reference properties: - url: https://docs.affinda.com/reference type: Documentation - url: openapi/affinda-organizations-api-openapi.yml type: OpenAPI description: >- Manage the top-level organization account — read and update organization details. Organizations contain users, billing, document types, and workspaces. Per-user limit of 3 API keys. - aid: affinda:affinda-data-sources-api name: Affinda Data Sources API tags: - Data Sources - Master Data - Matching humanURL: https://docs.affinda.com/reference properties: - url: https://docs.affinda.com/reference type: Documentation - url: openapi/affinda-data-sources-api-openapi.yml type: OpenAPI description: >- Manage custom mapping data sources — master-data lists used to match raw extracted values (vendor names, SKUs, categories) to known canonical entities. Upload values via the API and reference the data source from a document type field to enable automatic data matching during parsing. - aid: affinda:affinda-annotations-api name: Affinda Annotations API tags: - Annotations - Validation - Human in the Loop humanURL: https://docs.affinda.com/reference/annotations properties: - url: https://docs.affinda.com/reference/annotations type: Documentation - url: openapi/affinda-annotations-api-openapi.yml type: OpenAPI description: >- Manually create, update, and delete annotations on uploaded documents. Annotations are the field-level extraction objects (value, confidence, bounding box, parent field) and provide the surface for human-in-the-loop validation and review. Supports batch create, update, and delete for high-throughput review workflows. - aid: affinda:affinda-validation-results-api name: Affinda Validation Results API tags: - Validation - Quality - Human in the Loop humanURL: https://docs.affinda.com/reference properties: - url: https://docs.affinda.com/reference type: Documentation - url: openapi/affinda-validation-results-api-openapi.yml type: OpenAPI description: >- Track the status and findings of validation rules attached to parsed documents. Validation results record passes, failures, and remediation context for field-level rules and inform the embeddable validation UI. Supports batch create and delete. - aid: affinda:affinda-tags-api name: Affinda Tags API tags: - Tags - Metadata - Organization humanURL: https://docs.affinda.com/reference properties: - url: https://docs.affinda.com/reference type: Documentation - url: openapi/affinda-tags-api-openapi.yml type: OpenAPI description: >- Tag management for parsed documents. Tags can be arbitrarily attached to documents to support routing, segmentation, search filters, and downstream workflow triggers. Supports batch-add and batch-remove on document collections. - aid: affinda:affinda-usage-api name: Affinda Usage API tags: - Usage - Credits - Reporting - FinOps humanURL: https://docs.affinda.com/reference properties: - url: https://docs.affinda.com/reference type: Documentation - url: openapi/affinda-usage-api-openapi.yml type: OpenAPI description: >- Retrieve daily credits consumption for the organization across all workspaces and document types. Used for billing reconciliation, budget tracking, and FinOps reporting. - aid: affinda:affinda-webhooks-api name: Affinda Webhooks API tags: - Webhooks - Events - Integration humanURL: https://docs.affinda.com/reference/webhooks properties: - url: https://docs.affinda.com/reference/webhooks type: Documentation - url: openapi/affinda-webhooks-api-openapi.yml type: OpenAPI description: >- Resthook-style webhook subscriptions for document parsing events. Create a subscription, receive a probe payload, and call the activation endpoint to confirm the receiver. Affinda delivers events such as document parsed, document failed, and validation completed to the registered URL. - aid: affinda:affinda-search-match-api name: Affinda Search and Match API tags: - Search - Matching - Resume Search - Job Description Search - Recruitment humanURL: https://docs.affinda.com/reference properties: - url: https://docs.affinda.com/reference type: Documentation - url: openapi/affinda-search-match-api-openapi.yml type: OpenAPI description: >- Resume search, job description search, and matching across parsed-document indexes. Score candidates against a job description (or vice versa), retrieve match details, configure search and embed parameters, and request job-title and skill suggestions. Includes index management for organizing parsed documents and embeddable UI configuration for resume and JD search components. - aid: affinda:affinda-add-x-hidden-to-endpoints-api name: Affinda Add x-hidden to endpoints API description: >- Hidden endpoints not intended for public use. These endpoints include Splitting, Extractor, Organization, and Workspace Memberships & Usage functionality. humanURL: https://docs.affinda.com/reference/getting-started tags: - Add x-hidden to endpoints properties: - type: OpenAPI url: openapi/affinda-add-x-hidden-to-endpoints-api-openapi.yml - type: Documentation url: https://docs.affinda.com/reference - aid: affinda:affinda-deprecated-end-points-api name: Affinda Deprecated End Points API description: >- Deprecated endpoints that are maintained for backward compatibility. These endpoints include Data Point, Collection, and Users functionality that has been superseded by newer APIs. humanURL: https://docs.affinda.com/reference/getting-started tags: - Deprecated End Points properties: - type: OpenAPI url: openapi/affinda-deprecated-end-points-api-openapi.yml - type: Documentation url: https://docs.affinda.com/reference - aid: affinda:affinda-document-api-extractor-api name: Affinda Document API - Extractor API description: >- The Document API - Extractor API from Affinda — 2 operation(s) for document api - extractor. humanURL: https://docs.affinda.com/reference/getting-started tags: - Document API - Extractor properties: - type: OpenAPI url: openapi/affinda-document-api-extractor-api-openapi.yml - type: Documentation url: https://docs.affinda.com/reference - aid: affinda:affinda-document-api-splitting-api name: Affinda Document API - Splitting API description: >- The Document API - Splitting API from Affinda — 3 operation(s) for document api - splitting. humanURL: https://docs.affinda.com/reference/getting-started tags: - Document API - Splitting properties: - type: OpenAPI url: openapi/affinda-document-api-splitting-api-openapi.yml - type: Documentation url: https://docs.affinda.com/reference - aid: affinda:affinda-organization-api-invitation-api name: Affinda Organization API - Invitation API description: >- The Organization API - Invitation API from Affinda — 3 operation(s) for organization api - invitation. humanURL: https://docs.affinda.com/reference/getting-started tags: - Organization API - Invitation properties: - type: OpenAPI url: openapi/affinda-organization-api-invitation-api-openapi.yml - type: Documentation url: https://docs.affinda.com/reference name: Affinda tags: - AI - Artificial Intelligence - Document Processing - Intelligent Document Processing - IDP - OCR - Resume Parsing - Invoice Parsing - Receipt Parsing - Document Extraction - Document Classification - Document Splitting - Recruitment - Banking - Insurance - Logistics - Healthcare - Government kind: contract accessModel: pricing: paid onboarding: self-serve trial: true try_now: true public: false label: Paid (free trial) · Self-serve signup confidence: high source: - plans - authentication generated: '2026-07-22' method: derived image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/affinda.png access: 3rd-Party common: - type: AgenticAccess url: agentic-access/affinda-agentic-access.yml - type: TrustCenter url: security/affinda-trust-center.yml - type: DomainSecurity url: security/affinda-domain-security.yml - type: Authentication url: authentication/affinda-authentication.yml - type: PostmanWorkspace url: https://www.postman.com/kinlaneapi/affinda/overview - type: Arazzo url: arazzo/affinda-add-collection-data-field-workflow.yml name: Affinda Add a Data Field to a Collection - type: Arazzo url: arazzo/affinda-add-workspace-member-workflow.yml name: Affinda Add a Member to a Workspace - type: Arazzo url: arazzo/affinda-bootstrap-organization-workspace-workflow.yml name: Affinda Bootstrap Organization and Workspace - type: Arazzo url: arazzo/affinda-configure-resume-search-embed-workflow.yml name: Affinda Configure and Embed Resume Search - type: Arazzo url: arazzo/affinda-create-data-point-with-choices-workflow.yml name: Affinda Create Enum Data Point and Populate Choices - type: Arazzo url: arazzo/affinda-create-data-source-and-add-value-workflow.yml name: Affinda Create Mapping Data Source and Add a Value - type: Arazzo url: arazzo/affinda-create-document-from-data-and-index-workflow.yml name: Affinda Create Document from Data and Index It - type: Arazzo url: arazzo/affinda-create-extractor-with-data-point-workflow.yml name: Affinda Create Extractor with a Data Point - type: Arazzo url: arazzo/affinda-create-index-and-add-document-workflow.yml name: Affinda Create Search Index and Add a Document - type: Arazzo url: arazzo/affinda-create-tag-and-tag-documents-workflow.yml name: Affinda Create a Tag and Apply It to Documents - type: Arazzo url: arazzo/affinda-document-type-to-json-schema-workflow.yml name: Affinda Create Document Type and Generate JSON Schema - type: Arazzo url: arazzo/affinda-find-and-move-document-workflow.yml name: Affinda Find a Document and Move It to Another Collection - type: Arazzo url: arazzo/affinda-invite-member-and-respond-workflow.yml name: Affinda Invite Organization Member and Respond - type: Arazzo url: arazzo/affinda-job-description-search-and-detail-workflow.yml name: Affinda Job Description Search and Detail - type: Arazzo url: arazzo/affinda-parse-and-correct-annotations-workflow.yml name: Affinda Parse and Correct Annotations - type: Arazzo url: arazzo/affinda-parse-and-reject-document-workflow.yml name: Affinda Parse and Reject a Document - type: Arazzo url: arazzo/affinda-parse-and-validate-rule-workflow.yml name: Affinda Parse and Record a Validation Result - type: Arazzo url: arazzo/affinda-provision-and-ingest-document-workflow.yml name: Affinda Provision Collection and Ingest a Document - type: Arazzo url: arazzo/affinda-provision-workspace-collection-workflow.yml name: Affinda Provision Workspace and Collection - type: Arazzo url: arazzo/affinda-rename-document-type-and-refresh-schema-workflow.yml name: Affinda Rename Document Type and Refresh Its Schema - type: Arazzo url: arazzo/affinda-resume-search-and-detail-workflow.yml name: Affinda Resume Search and Detail - type: Arazzo url: arazzo/affinda-split-document-and-reparse-workflow.yml name: Affinda Split a Document and Re-parse - type: Arazzo url: arazzo/affinda-update-resume-data-and-reindex-workflow.yml name: Affinda Update Resume Data and Re-index - type: Arazzo url: arazzo/affinda-upload-and-parse-document-workflow.yml name: Affinda Upload and Parse a Document - type: Arazzo url: arazzo/affinda-upload-from-url-and-validate-workflow.yml name: Affinda Upload from URL, Parse, and Confirm - type: Arazzo url: arazzo/affinda-webhook-subscribe-and-activate-workflow.yml name: Affinda Subscribe and Activate a Webhook - type: Arazzo url: arazzo/affinda-workspace-usage-report-workflow.yml name: Affinda Workspace Usage Report - type: Portal url: https://www.affinda.com - type: Documentation url: https://docs.affinda.com - type: GettingStarted url: https://docs.affinda.com/reference/getting-started - type: OpenAPI url: https://api.affinda.com/static/v3/api_spec.yaml - type: AgentSkills url: https://docs.affinda.com/skill.md name: Affinda Skill File for AI Agents - type: APIReference url: https://docs.affinda.com/reference - type: Pricing url: https://www.affinda.com/pricing - type: Signup url: https://app.affinda.com/auth/register - type: Login url: https://app.affinda.com/auth/login - type: Login url: https://app.us1.affinda.com/auth/login name: US Region Login - type: Login url: https://app.eu1.affinda.com/auth/login name: EU Region Login - type: Authentication url: https://docs.affinda.com/reference/authentication - type: Webhooks url: https://docs.affinda.com/reference/webhooks - type: ChangeLog url: https://docs.affinda.com/changelog - type: Blog url: https://www.affinda.com/blog - type: Academy url: https://www.affinda.com/affinda-academy - type: Support url: https://support.affinda.com - type: ContactUs url: https://www.affinda.com/contact - type: Security url: https://www.affinda.com/security - type: TermsOfService url: https://www.affinda.com/legal/terms-of-use - type: PrivacyPolicy url: https://www.affinda.com/legal/privacy-policy - type: GitHubOrganization url: https://github.com/affinda - type: LinkedIn url: https://www.linkedin.com/company/affinda - type: Twitter url: https://twitter.com/affinda_ai - type: SDKs url: https://github.com/affinda/affinda-python name: Python SDK (affinda-python) - type: SDKs url: https://github.com/affinda/affinda-typescript name: TypeScript / JavaScript SDK (affinda-typescript) - type: SDKs url: https://www.npmjs.com/package/@affinda/affinda name: NPM Package @affinda/affinda - type: SDKs url: https://pypi.org/project/affinda/ name: PyPI Package affinda - type: SDKs url: https://www.nuget.org/packages/Affinda.API name: .NET NuGet Package Affinda.API - type: SDKs url: https://central.sonatype.com/artifact/com.affinda.api/affinda-api-client name: Java Maven Artifact com.affinda.api:affinda-api-client - type: Regions data: - region: AUS/Global baseURL: https://api.affinda.com app: https://app.affinda.com - region: US baseURL: https://api.us1.affinda.com app: https://app.us1.affinda.com - region: EU baseURL: https://api.eu1.affinda.com app: https://app.eu1.affinda.com - type: Compliance data: - SOC 2 Type II - ISO 27001:2022 - GDPR - HIPAA (Enterprise tier) - url: plans/affinda-plans-pricing.yml type: Plans - url: rate-limits/affinda-rate-limits.yml type: RateLimits - url: finops/affinda-finops.yml type: FinOps - type: Features data: - Intelligent Document Processing platform with natural-language workflow configuration - Resume parsing with skills, work experience, education, and language extraction - Invoice parsing with line items, tax breakdown, supplier matching, and currency normalization - Receipt parsing for expense automation - Passport and ID document extraction - Contract data extraction and clause identification - Custom document types configured via dashboard or natural language - Document splitting and classification across multi-document PDFs - Handwriting / OCR recognition - Table extraction across complex multi-page tables - Confidence scoring with bounding box coordinates on every field - Master-data matching against custom mapping data sources - Validation rules and embeddable validation UI (Business and Enterprise tiers) - Resume search and matching against job descriptions with score breakdown - Job description search against indexed resumes - Workspace + collection scoping for multi-tenant document orgs - Resthook-style webhook subscriptions with activation handshake - Webhook events for document parsed, failed, and validated states - Daily credits usage reporting at organization and workspace level - High-priority queue (20 documents/minute) and unlimited low-priority queue - Multi-region deployment (AUS/Global, US, EU) with data residency - SOC 2 Type II, ISO 27001:2022, GDPR, and HIPAA (Enterprise) compliance - On-premise / private-cloud deployment available on Enterprise - SSO and dedicated environment options on Enterprise - Free 14-day pay-as-you-go trial with prepaid credits - Official Python, TypeScript, .NET, and Java client libraries - skill.md file for AI agents (Claude Code, Cursor) describing the full API surface sources: - https://www.affinda.com - https://www.affinda.com/pricing - https://docs.affinda.com/reference/getting-started - https://docs.affinda.com/skill.md updated: '2026-05-25' created: '2026-05-25T00:00:00.000Z' modified: '2026-05-25' position: Consuming description: >- Affinda is an Intelligent Document Processing (IDP) platform that uses AI to extract structured data from documents — resumes, invoices, receipts, contracts, passports, IDs, and custom document types. The v3 REST API exposes document upload and parsing, document type configuration, workspaces, collections, data sources for master-data matching, validation results, annotations for human-in-the-loop review, webhooks via resthook subscriptions, daily usage reporting, and resume / job-description search and match for recruitment workflows. The platform is deployed across AUS/Global, US, and EU regions for data residency, holds SOC 2 Type II and ISO 27001:2022 certification, and ships official Python, TypeScript, .NET, and Java SDKs alongside a skill.md file for AI coding agents. maintainers: - FN: Kin Lane email: info@apievangelist.com X: apievangelist url: https://apievangelist.com specificationVersion: '0.16'