For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI ReferenceChangelogModel Versioning
GuidesAPI ReferenceChangelogModel Versioning
    • Getting Started
    • Authentication
    • API Versioning
    • SDKs
    • Deployments
  • Processor Endpoints
    • POSTRun Processor
    • GETGet Processor Run
    • GETList Processor Runs
    • POSTCancel Processor Run
    • DELDelete Processor Run
    • GETGet Batch Processor Run
    • GETList Processors
    • POSTCreate Processor
    • POSTUpdate Processor
    • POSTPublish Processor Version
    • GETGet Processor Version
    • GETList Processor Versions
  • Parse Endpoints
    • POSTParse File
    • POSTParse File Async
    • GETGet Parser Run
    • DELDelete Parser Run
  • Workflow Endpoints
    • POSTRun Workflow
    • GETGet Workflow Run
    • GETList Workflow Runs
    • POSTUpdate Workflow Run
    • POSTCancel Workflow Run
    • DELDelete Workflow Run
    • POSTCreate Workflow
    • POSTBatch Run Workflow
    • POSTCorrect Workflow Run Outputs
  • File Endpoints
    • POSTUpload File
    • GETGet File
    • DELDelete File
    • GETList Files
    • POSTCreate File
  • Edit Endpoints
    • POSTEdit File
    • POSTEdit File Async
    • POSTGenerate Edit Schema
    • GETGet Edit Run
    • DELDelete Edit Run
    • GETGet Edit Template
  • Evaluation Set Endpoints
    • GETGet Evaluation Set
    • GETList Evaluation Sets
    • POSTCreate Evaluation Set
    • GETList Evaluation Set Items
    • POSTCreate Evaluation Set Item
    • POSTUpdate Evaluation Set Item
    • DELDelete Evaluation Set Item
    • POSTBulk Create Evaluation Set Items
LogoLogo
On this page
  • Obtaining an API Token
  • API Key Scopes
  • Example Usage
  • Error Handling

Authentication Overview

Was this page helpful?
Previous

API Versioning

Next
Built with

The Extend API uses Bearer token authentication for all API requests. You’ll need to use your API token when instantiating the client if you’re using the SDK or in the Authorization header of each request if you’re using the API directly.

Obtaining an API Token

  1. Navigate to the Extend Developer Settings
  2. Create a new API key or copy an existing one

Important: Keep your API tokens secure and never share them publicly. Rotate them regularly and immediately if they’re ever compromised.

API Key Scopes

API keys have a scope of either organization or workspace:

  • Workspace keys — Scoped to a single workspace and work for requests to that workspace.
  • Organization keys — These keys work across any workspace in the org. Must be used with the X-Extend-Workspace-Id header to specify the workspace. Only org admins can create keys with organization scope.

Example Usage

POST
/workflow_runs
1curl -X POST https://api.extend.ai/workflow_runs \
2 -H "x-extend-api-version: 2026-02-09" \
3 -H "Authorization: Bearer <token>" \
4 -H "Content-Type: application/json" \
5 -d '{
6 "workflow": {
7 "id": "wf_1234567890"
8 },
9 "file": {
10 "url": "https://example.com/invoice.pdf"
11 }
12}'
Try it

Error Handling

If authentication fails, you’ll receive a 401 Unauthorized response. Common causes include:

  • Missing the Authorization header
  • Invalid token format
  • Expired or revoked token
  • Insufficient permissions for the requested resource