REST API v1 · Coming soon

    Build with the Outworx API

    Integrate AI-powered document extraction, supplier intelligence, and accounting sync directly into your workflows. Process invoices, receipts, and expenses at scale.

    AI Extraction

    Extract vendor, amount, dates, and line items from any document in under 15 seconds.

    Enterprise Security

    Bearer token auth, TLS 1.3, RLS-protected data, and full audit logging on every request.

    Accounting Sync

    Push extracted data to Xero or QuickBooks with a single API call, coded to your chart of accounts and tax rates.

    Authentication

    All API requests require a Bearer token in the Authorization header. Generate your API key from your Outworx dashboard under Settings → API Keys.

    curl "https://api.outworx.ai/v1/documents" \
      -H "Authorization: Bearer owx_sk_live_a1b2c3d4e5f6..."
      
    # API keys use the prefix:
    #   owx_sk_live_  →  Production
    #   owx_sk_test_  →  Sandbox (no billing)
    Rate limit: 1,000 req/min
    Max upload: 25 MB per file
    Webhooks: Real-time events

    Endpoint Explorer

    Browse and test every endpoint interactively

    POST
    /v1/documents

    Upload Document

    Upload an invoice, receipt, or expense document for AI-powered extraction. Supports PDF, JPEG, PNG, and HEIC formats up to 25 MB.

    Parameters

    NameTypeRequiredDescription
    file_namestring
    Required
    Original file name with extension
    file_typestring
    Required
    MIME type of the document
    file_datastring
    Required
    Base64-encoded file content
    client_iduuidOptionalAssociate document with a client
    sourcestringOptionalOrigin identifier (default: 'api')

    Request Example

    curl -X POST "https://api.outworx.ai/v1/documents" \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "file_name": "invoice-2024-001.pdf",
        "file_type": "application/pdf",
        "file_data": "<base64-encoded-content>",
        "client_id": "c9a2f3e1-...",
        "source": "api"
      }'

    Response

    200 OK
    {
      "id": "d7b4e8f2-1a3c-4d5e-9f6a-7b8c9d0e1f2a",
      "status": "processing",
      "file_name": "invoice-2024-001.pdf",
      "created_at": "2026-03-11T10:30:00Z",
      "estimated_completion": "~15 seconds"
    }

    Webhooks

    Receive real-time notifications when documents finish processing, exceptions are detected, or accounting sync completes. Configure webhook endpoints in your dashboard.

    document.completed
    document.failed
    supplier.created
    integration.synced
    exception.detected

    Official SDKs

    Coming soon — native client libraries for popular languages.

    JavaScript / TypeScript
    Coming Soon
    Python
    Coming Soon
    Ruby
    Coming Soon
    PHP
    Coming Soon

    Ready to Integrate?

    The public API is coming soon. Email api@outworx.ai to join early access and get sandbox credentials when it opens.