Skip to main content
PATCH
/
v1
/
agents
/
{agent_id}
/
extraction-schemas
/
{schema_id}
Update extraction schema (rename, activate, archive)
curl --request PATCH \
  --url https://api-sandbox.featherhq.com/v1/agents/{agent_id}/extraction-schemas/{schema_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": 123,
  "name": "<string>",
  "description": "<string>",
  "schema_json": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
agent_id
string<uuid>
required
​
schema_id
string<uuid>
required

Body

application/json

Partial update of an extraction schema — only supplied fields change.

Explicit null is rejected for non-nullable columns (name, status) — omit the field instead. description is the only nullable column, so it accepts null as a clear-the-column signal. Mirrors PersonaUpdate so a wire-level {"name": null} fails fast instead of returning a misleading 200 with no change applied.

​
name
string | null
Required string length: 1 - 255
​
description
string | null
Maximum string length: 2000
​
status
enum<string> | null
Available options:
active,
archived

Response

Successful Response

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
agent_id
string<uuid>
required
​
version
integer
required
​
name
string
required
​
description
string | null
required
​
schema_json
Schema Json · object
required
​
status
enum<string>
required
Available options:
draft,
active,
archived
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required