Update Extractor

PUT /api/v1/e/{extractor_id} Update the name or slug of an existing extractor. This endpoint only modifies metadata — to update the extraction logic, use the Extractor Builder in the Doctly dashboard.

Some extractors installed from the catalog cannot be modified.

Request

Headers

string

required

Bearer token authentication. Example: Bearer YOUR_API_KEY

string

required

Must be application/json

Path Parameters

string

required

The unique identifier (UUID) of the extractor to update

Body Parameters

string

New display name for the extractor (max 255 characters)

string

New URL-friendly identifier (3-100 characters, must be unique within your account)

Example Request

curl -X PUT https://api.doctly.ai/api/v1/e/987fcdeb-a654-3210-9876-543210987654 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Invoice Parser v2",
    "slug": "invoice-parser-v2"
  }'

import requests

extractor_id = "987fcdeb-a654-3210-9876-543210987654"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
    "name": "Invoice Parser v2",
    "slug": "invoice-parser-v2"
}

response = requests.put(
    f"https://api.doctly.ai/api/v1/e/{extractor_id}",
    headers=headers,
    json=data
)

print(response.json())

const extractorId = '987fcdeb-a654-3210-9876-543210987654';

const response = await fetch(
  `https://api.doctly.ai/api/v1/e/${extractorId}`,
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: 'Invoice Parser v2',
      slug: 'invoice-parser-v2'
    })
  }
);

const extractor = await response.json();
console.log(`Updated: ${extractor.name}`);

Response

Returns the updated extractor object.

Show Extractor Object

string

Unique identifier (UUID) for the extractor

string

Updated display name

string

Updated URL-friendly identifier

string

Description of the extractor

string

Pricing model: PER_PAGE or PER_DOCUMENT

integer

Credits charged per page or per document

Example Responses

{
  "id": "987fcdeb-a654-3210-9876-543210987654",
  "name": "Invoice Parser v2",
  "slug": "invoice-parser-v2",
  "description": "Extract invoice details including vendor, line items, and totals",
  "cost_type": "PER_PAGE",
  "cost_credits": 5
}

{
  "detail": "This extractor cannot be edited."
}

{
  "detail": "Extractor not found or you do not have access to it."
}

{
  "detail": "An active extractor with slug 'invoice-parser-v2' already exists."
}

{
  "detail": [
    {
      "loc": ["body", "slug"],
      "msg": "ensure this value has at least 3 characters",
      "type": "value_error.any_str.min_length"
    }
  ]
}

Slug Requirements

The slug must:

Be 3-100 characters long
Be unique within your account
Be URL-friendly (lowercase letters, numbers, and hyphens recommended)

Changing an extractor’s slug will break any integrations using the old slug. Update your API calls to use the new slug.

API Overview

Documents

Extractors

Collections

Collection Files

Chat

Update Extractor

Request

Headers

Path Parameters

Body Parameters

Example Request

Response

Example Responses

Slug Requirements

​Request

​Headers

​Path Parameters

​Body Parameters

​Example Request

​Response

​Example Responses

​Slug Requirements

Request

Headers

Path Parameters

Body Parameters

Example Request

Response

Example Responses

Slug Requirements