Skip to main content
PATCH
Update Disposition Extractor Draft

Overview

Dispositions are enabled per organization. If your organization does not have access, these endpoints return 404.
Edits the extractor’s editable version in place. Only the fields you send change; the merged draft is validated with the same rules as Create Disposition Extractor. Published versions are never modified; to make the edited draft pinnable, call Publish Disposition Extractor. Requires an admin, owner, operator, or prompter role.

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
The agent’s unique identifier. A malformed id returns 400 with the message agentId must be a valid UUID.
string
required
The extractor’s unique identifier. Must be organization-wide or scoped to this agent; otherwise returns 404 with the message Disposition extractor not found. A malformed id returns 400 with the message extractorId must be a valid UUID.

Body Parameters

Unknown fields are rejected. A body that fails shape validation returns 400 with the message Invalid request body; a merged draft that breaks a prompt, schema, or model-profile rule returns 400 with the message Extractor definition failed validation. In both cases the error’s ext field is a JSON string listing each problem.
string
required
The extractor’s current currentVersionId. If another update or publish has moved it, the request returns 409 CONFLICT with the message Extractor draft changed; refresh and try again.
integer
required
The extractor’s current draftRevision. Minimum 1. A stale value returns the same 409 CONFLICT.
string
New display name, 1 to 120 characters. Updates both the extractor record and the draft version.
string | null
New description, up to 2000 characters. Send null to clear it. Updates both the extractor record and the draft version.
string
New system prompt in Markdown. Up to 8000 characters and 8000 UTF-8 bytes.
string
New extraction prompt in Markdown. 1 to 8000 characters, up to 8000 UTF-8 bytes, and must contain non-whitespace text. systemPromptMd and promptMd together may not exceed 16000 UTF-8 bytes.
object
Replaces the whole output schema. Same shape and limits as on Create Disposition Extractor.
object
Replaces the whole inference configuration, so contextSources is required inside it. Same fields and limits as on Create Disposition Extractor. modelProfileKey defaults to balanced when omitted.

Response

object
The extractor record after the update, with draftRevision incremented by 1.
object
The updated editable version.
null | array
null on success, or a list of error objects if the request failed.

Docs for agents: llms.txt