Skip to main content
List Extractors
curl --request GET \
  --url https://api.doctly.ai/api/v1/e \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.doctly.ai/api/v1/e"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.doctly.ai/api/v1/e', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.doctly.ai/api/v1/e",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.doctly.ai/api/v1/e"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.doctly.ai/api/v1/e")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.doctly.ai/api/v1/e")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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"
}
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"

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

​
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
}

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

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

​
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