Skip to main content
PATCH
Update extraction schema (rename, activate, archive)

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