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.
Book a demoLog in
ProductAPI ReferenceChangelogModel Versioning
ProductAPI ReferenceChangelogModel Versioning
    • Authentication
    • API Versioning
  • Workflow Endpoints
    • Run Workflow
    • Workflow Run
    • List Workflow Runs
    • Update Workflow Run
    • Create Workflow
    • Batch Run Workflow
    • Correct Workflow Run (Deprecated)
  • Processor Endpoints
    • Run Processor
    • Get Processor Run
    • Batch Processor Run
    • Create Processor
    • Update Processor
    • Publish Processor Version
    • Processor Version
    • List Processor Versions
  • Parse Endpoints
    • Parse File
  • File Endpoints
    • Upload File
    • Get File
    • List Files
    • Create File (Deprecated)
  • Evaluation Set Endpoints
    • Create Evaluation Set
    • Create Evaluation Set Item
    • Update Evaluation Set Item
    • Bulk Create Evaluation Set Item
  • Objects
    • Block
    • Evaluation Set
    • Evaluation Set Item
    • File
    • Processor
    • Processor Run
    • Batch Processor Run
    • Processor Version
    • Workflow
    • Workflow Run
    • Workflow Run Summary
  • Guides
    • Processor Configs
    • Output Types
    • Bounding Boxes
    • Supported File Types
    • Rate Limits
    • User Roles and Permissions
  • Webhooks
    • Configuration
    • Events
LogoLogo
Book a demoLog in
On this page
  • Overview
  • Obtaining an API Token
  • Making Authenticated Requests
  • HTTP Header Format
  • Example Requests
  • Using Node.js (fetch)
  • Using cURL
  • Error Handling

Authentication

Learn how to authenticate your requests to the Extend API
Was this page helpful?

API Versioning

Learn how to specify API versions and stay up to date with changes
Next
Built with

Overview

The Extend platform uses Bearer token authentication for all API requests. You’ll need to include your API token in the Authorization header of each request.

Obtaining an API Token

  1. Log into the Extend Dashboard
  2. Navigate to Settings → Developer
  3. 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.

Making Authenticated Requests

HTTP Header Format

Include your API token in the Authorization header:

$Authorization: Bearer <API_TOKEN>

Example Requests

Using Node.js (fetch)

1const makeAuthenticatedRequest = async () => {
2 const response = await fetch('https://api-prod.extend.app/workflow_runs/workflow_run_1234', {
3 method: 'GET',
4 headers: {
5 'Authorization': 'Bearer YOUR_API_TOKEN',
6 'Content-Type': 'application/json',
7 'Extend-Api-Version': '2024-11-14'
8 }
9 });
10
11 return response.json();
12};

Using cURL

1curl -X GET https://api-prod.extend.app/workflow_runs \
2 -H "Authorization: Bearer YOUR_API_TOKEN" \
3 -H "Content-Type: application/json" \
4 -H "Extend-Api-Version: 2024-11-14"
5 -d '{ ... }'

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