List Extractors

{
  "data": [
    {
      "id": "987fcdeb-a654-3210-9876-543210987654",
      "name": "Invoice Extractor",
      "slug": "invoice-extractor",
      "description": "Extract invoice details including vendor, line items, and totals",
      "cost_type": "PER_PAGE",
      "cost_credits": 5
    },
    {
      "id": "abc12345-e89b-12d3-a456-426614174000",
      "name": "Resume Parser",
      "slug": "resume-parser",
      "description": "Extract candidate information from resumes",
      "cost_type": "PER_DOCUMENT",
      "cost_credits": 10
    },
    {
      "id": "def67890-e89b-12d3-a456-426614174000",
      "name": "Bank Statement Analyzer",
      "slug": "bank-statement",
      "description": "Extract transactions and account details from bank statements",
      "cost_type": "PER_PAGE",
      "cost_credits": 8
    }
  ],
  "count": 3
}

{
  "data": [],
  "count": 0
}

{
  "detail": "Invalid or missing API key"
}

GET /api/v1/e List all active extractors available to your account. This includes extractors you’ve created and any extractors installed from the catalog.

Request

Headers

string

required

Bearer token authentication. Example: Bearer YOUR_API_KEY

Query Parameters

integer

default:"0"

Number of records to skip for pagination

integer

default:"100"

Maximum number of records to return

Example Request

curl https://api.doctly.ai/api/v1/e \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.get(
    "https://api.doctly.ai/api/v1/e",
    headers=headers
)

data = response.json()
print(f"Found {data['count']} extractors")

for extractor in data['data']:
    print(f"  {extractor['name']} ({extractor['slug']})")

const response = await fetch('https://api.doctly.ai/api/v1/e', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(`Found ${data.count} extractors`);

data.data.forEach(extractor => {
  console.log(`  ${extractor.name} (${extractor.slug})`);
});

Response

array

Array of extractor objects

Show Extractor Object

string

Unique identifier (UUID) for the extractor

string

Display name of the extractor

string

URL-friendly identifier used in API paths

string

Description of what the extractor does

string

Pricing model: PER_PAGE or PER_DOCUMENT

integer

Credits charged per page or per document

integer

Total number of extractors available

Example Responses

{
  "data": [
    {
      "id": "987fcdeb-a654-3210-9876-543210987654",
      "name": "Invoice Extractor",
      "slug": "invoice-extractor",
      "description": "Extract invoice details including vendor, line items, and totals",
      "cost_type": "PER_PAGE",
      "cost_credits": 5
    },
    {
      "id": "abc12345-e89b-12d3-a456-426614174000",
      "name": "Resume Parser",
      "slug": "resume-parser",
      "description": "Extract candidate information from resumes",
      "cost_type": "PER_DOCUMENT",
      "cost_credits": 10
    },
    {
      "id": "def67890-e89b-12d3-a456-426614174000",
      "name": "Bank Statement Analyzer",
      "slug": "bank-statement",
      "description": "Extract transactions and account details from bank statements",
      "cost_type": "PER_PAGE",
      "cost_credits": 8
    }
  ],
  "count": 3
}

{
  "data": [],
  "count": 0
}

{
  "detail": "Invalid or missing API key"
}

Pricing Models

Extractors use one of two pricing models:

Cost Type	Description
`PER_PAGE`	Credits charged for each page in the document
`PER_DOCUMENT`	Flat credit charge per document regardless of page count

API Overview

Documents

Extractors

Collections

Collection Files

Chat

List Extractors

Request

Headers

Query Parameters

Example Request

Response

Example Responses

Pricing Models

​Request

​Headers

​Query Parameters

​Example Request

​Response

​Example Responses

​Pricing Models

Request

Headers

Query Parameters

Example Request

Response

Example Responses

Pricing Models