Skip to main content
Update Extractor
curl --request PUT \
  --url https://api.doctly.ai/api/v1/e/{extractor_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>"
}
'
{
  "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
}

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.

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

​
Authorization
string
required
Bearer token authentication. Example: Bearer YOUR_API_KEY
​
Content-Type
string
required
Must be application/json

​
Path Parameters

​
extractor_id
string
required
The unique identifier (UUID) of the extractor to update

​
Body Parameters

​
name
string
New display name for the extractor (max 255 characters)
​
slug
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"
  }'

​
Response

Returns the updated extractor object.

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

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

Authorizations

​
Authorization
string
header
required

API key authentication using Bearer token

Path Parameters

​
extractor_id
string<uuid>
required

Extractor ID

Body

application/json
​
name
string
Maximum string length: 255
​
slug
string
Required string length: 3 - 100

Response

Extractor updated

​
id
string<uuid>
required
​
name
string
required
​
slug
string
required
​
cost_type
enum<string>
required
Available options:
PER_PAGE,
PER_DOCUMENT
​
cost_credits
integer
required
​
description
string | null