Skip to main content
List Extractors
curl --request GET \
  --url https://api.doctly.ai/api/v1/e \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.doctly.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Request

​
Headers

​
Authorization
string
required
Bearer token authentication. Example: Bearer YOUR_API_KEY

​
Query Parameters

​
skip
integer
default:"0"
Number of records to skip for pagination
​
limit
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"

​
Response

​
data
array
Array of extractor objects
​
count
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
}

​
Pricing Models

Extractors use one of two pricing models:
Cost TypeDescription
PER_PAGECredits charged for each page in the document
PER_DOCUMENTFlat credit charge per document regardless of page count

Authorizations

​
Authorization
string
header
required

API key authentication using Bearer token

Query Parameters

​
skip
integer
default:0

Number of records to skip

​
limit
integer
default:100

Maximum number of records to return

Response

200 - application/json

List of extractors

​
data
object[]
required
​
count
integer
required