> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bland.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Disposition Extractor

> Create an extractor with its first editable version.

### Overview

> [!NOTE]
>
> 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](https://docs.bland.ai/api-v2/patch/agents-id-dispositions-extractors-extractor-id-draft.md), then make it pinnable with [Publish Disposition Extractor](https://docs.bland.ai/api-v2/post/agents-id-dispositions-extractors-extractor-id-publish.md).

Requires an admin, owner, operator, or prompter role.

### Headers

**authorization** `string` *required*

Your API key for authentication.

### Path Parameters

**agent\_id** `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.

**key** `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`.

**name** `string` *required*

Display name. 1 to 120 characters.

**description** `string | null`

Optional description, up to 2000 characters.

**scopedToAgent** `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.

**systemPromptMd** `string`

Optional system prompt in Markdown. Up to 8000 characters and 8000 UTF-8 bytes.

**promptMd** `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.

**outputSchema** `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.

**outputSchema fields**

**kind** `string` *required*

One of `boolean`, `string`, `number`, `enum`, `array`, `object`.

**description** `string`

Optional guidance for the model, up to 2000 characters. Allowed on every kind.

**format** `string`

`string` only. The single accepted value is `date-time`.

**options** `array`

`enum` only, required for that kind. 1 to 24 objects of the form `{ "key": "booked", "label": "Booked" }`. `key` is 1 to 64 characters and must be unique within the enum; `label` is 1 to 120 characters.

**items** `object`

`array` only, required for that kind. A nested schema node describing each element.

**minItems** `integer`

`array` only. Minimum `0`, at most 1000, and not greater than `maxItems`.

**maxItems** `integer`

`array` only. Minimum `1`, at most 1000.

**properties** `object`

`object` only, required for that kind. Map of property names (up to 64 characters each, at most 64 properties) to nested schema nodes. `__proto__`, `constructor`, and `prototype` are not allowed as names.

**required** `array`

`object` only, required for that kind. Property names that must be present in the produced value. Each must be declared in `properties`, with no duplicates. Pass `[]` when nothing is required.

**inferenceConfig** `object` *required*

How the extractor runs. Unknown fields are rejected.

**inferenceConfig fields**

**contextSources** `array` *required*

Evidence the extractor reads. 1 to 8 unique values from `transcript`, `audio_recording`, `call_metadata`, `pathway_logs`, `tool_logs`, `variables`, `agent_config`, `call_config`. Including `audio_recording` requires a model profile whose `supportsAudio` is `true`.

**modelProfileKey** `string` (default: balanced)

One of the `key` values returned by [Get Model Profile Catalog](https://docs.bland.ai/api-v2/get/agents-id-dispositions-model-profile-catalog.md). 1 to 120 characters. A key that is not in the catalog returns `400` with the message `Extractor model profile is not available`.

**temperature** `number | null`

Sampling temperature between `0` and `2`.

**maxOutputTokens** `integer | null`

Output token cap between `1` and `64000`.

**thinking** `string | null`

Reasoning effort: `low`, `medium`, or `high`.

### Response

Returns `201` on success.

**data.extractor** `object`

The new extractor.

**extractor object**

**id** `string`

Unique identifier for the extractor.

**agentId** `string | null`

`null` for an organization-wide extractor. Otherwise this agent's id.

**key** `string`

The `key` you supplied.

**name** `string`

The extractor's display name.

**description** `string | null`

Optional description.

**currentVersionId** `string`

The `editable` draft version, the same id as `data.currentVersion.id`. Pass it as `expectedVersionId` when updating or publishing.

**activeVersionId** `null`

Always `null` on a new extractor; set by the first publish.

**draftRevision** `integer`

Always `1` on a new extractor. Pass it as `expectedDraftRevision` when updating or publishing.

**createdAt** `string`

ISO 8601 timestamp of creation.

**updatedAt** `string`

ISO 8601 timestamp of the last update.

**data.currentVersion** `object`

Version `1`, in the `editable` state.

**version object**

**id** `string`

Unique identifier for the version.

**extractorId** `string`

The extractor this version belongs to.

**versionNumber** `integer`

`1` for a new extractor. Increments on each publish.

**state** `string`

`editable` for the live draft, `archived` once published.

**name** `string`

Display name at this version.

**description** `string | null`

Description at this version.

**systemPromptMd** `string`

The system prompt. Empty string when none was supplied.

**promptMd** `string`

The extraction prompt.

**outputSchema** `object`

The schema you supplied.

**inferenceConfig** `object`

The configuration you supplied, with `modelProfileKey` always populated (defaulted to `balanced` when omitted). `temperature`, `maxOutputTokens`, and `thinking` are omitted when you did not send them.

**createdAt** `string`

ISO 8601 timestamp of creation.

**updatedAt** `string`

ISO 8601 timestamp of the last update.

**errors** `null | array`

`null` on success, or a list of error objects if the request failed.

```json Response theme={null}
{
  "data": {
    "extractor": {
      "id": "d6486956-e583-448f-9cb2-3f98dcc0fada",
      "agentId": null,
      "key": "appointment_outcome",
      "name": "Appointment outcome",
      "description": "Whether an appointment was booked, rescheduled, or declined.",
      "currentVersionId": "ca112e02-a762-49b0-ba0e-dff4c57ee8ad",
      "activeVersionId": null,
      "draftRevision": 1,
      "createdAt": "2026-09-10T16:20:45.312Z",
      "updatedAt": "2026-09-10T16:20:45.318Z"
    },
    "currentVersion": {
      "id": "ca112e02-a762-49b0-ba0e-dff4c57ee8ad",
      "extractorId": "d6486956-e583-448f-9cb2-3f98dcc0fada",
      "versionNumber": 1,
      "state": "editable",
      "name": "Appointment outcome",
      "description": "Whether an appointment was booked, rescheduled, or declined.",
      "systemPromptMd": "",
      "promptMd": "Decide whether the caller booked, rescheduled, or declined an appointment. Return unclear if the call ended before a decision.",
      "outputSchema": {
        "kind": "enum",
        "description": "Final appointment outcome for this call.",
        "options": [
          { "key": "booked", "label": "Booked" },
          { "key": "rescheduled", "label": "Rescheduled" },
          { "key": "declined", "label": "Declined" },
          { "key": "unclear", "label": "Unclear" }
        ]
      },
      "inferenceConfig": {
        "modelProfileKey": "balanced",
        "thinking": "low",
        "contextSources": ["transcript", "call_metadata"]
      },
      "createdAt": "2026-09-10T16:20:45.312Z",
      "updatedAt": "2026-09-10T16:20:45.312Z"
    }
  },
  "errors": null
}
```

```json Invalid Body theme={null}
{
  "data": null,
  "errors": [
    {
      "error": "BAD_REQUEST",
      "message": "Invalid request body",
      "ext": "{\"errors\":[\"/promptMd: Expected required property\"]}"
    }
  ]
}
```

```json Invalid Definition theme={null}
{
  "data": null,
  "errors": [
    {
      "error": "BAD_REQUEST",
      "message": "Extractor definition failed validation",
      "ext": "{\"problems\":[\"Call audio extraction requires an audio-capable model profile\"]}"
    }
  ]
}
```

```json Conflict theme={null}
{
  "data": null,
  "errors": [
    {
      "error": "CONFLICT",
      "message": "An extractor with key \"appointment_outcome\" already exists"
    }
  ]
}
```

***

Docs for agents: [llms.txt](https://docs.bland.ai/llms.txt)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.