Skip to main content
POST
Create Disposition Extractor

Overview

Dispositions are enabled per organization. If your organization does not have access, these endpoints return 404.
Creates an extractor and its version 1 in the editable state. An extractor is a prompt plus an output schema that pulls a structured value out of call evidence; a disposition value pins a published extractor version to run it after each call. Edit the draft with Update Disposition Extractor Draft, then make it pinnable with 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.

Body Parameters

Unknown fields are rejected. A body that fails shape validation returns 400 with the message Invalid request body; a body that passes shape validation but 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
Stable machine key for the extractor. 1 to 64 characters matching ^[a-z][a-z0-9_]*$. Must be unique within your organization; a duplicate returns 409 CONFLICT.
string
required
Display name. 1 to 120 characters.
string | null
Optional description, up to 2000 characters.
boolean
default:"false"
true limits the extractor to this agent. When false or omitted, the extractor is organization-wide and available to every agent’s dispositions.
string
default:""
Optional system prompt in Markdown. Up to 8000 characters and 8000 UTF-8 bytes.
string
required
The 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
required
The shape of the value the extractor produces. A schema node is an object with a kind plus kind-specific fields; array and object nodes nest further schema nodes. The whole schema may nest at most 8 levels deep, contain at most 200 nodes, and serialize to at most 64 KB.
object
required
How the extractor runs. Unknown fields are rejected.

Response

Returns 201 on success.
object
The new extractor.
object
Version 1, in the editable state.
null | array
null on success, or a list of error objects if the request failed.

Docs for agents: llms.txt