Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Decisions

Create a decision
POST/decisions
ModelsExpand Collapse
Decision object { answers, model, usage }
answers: array of object { name, probability, type } or object { choice, confidence, name, 2 more } or object { confidence, name, probabilities, 2 more } or object { name, type }
One of the following:
Predicate object { name, probability, type }
name: string or null
minLength0
probability: number
type: "predicate"

The type of the object. Always predicate.

Choice object { choice, confidence, name, 2 more }
choice: string or boolean

Choice values are typed: a string and a boolean with the same text are distinct.

One of the following:
string
boolean
confidence: number
name: string or null
minLength0
probabilities: array of object { probability, value }
probability: number
value: string or boolean

Choice values are typed: a string and a boolean with the same text are distinct.

One of the following:
string
boolean
type: "choice"

The type of the object. Always choice.

Score object { confidence, name, probabilities, 2 more }
confidence: number
name: string or null
minLength0
probabilities: array of object { label, probability, value }
label: string
minLength0
probability: number
value: number
formatint64
score: number
type: "score"

The type of the object. Always score.

Refusal object { name, type }

The model declined to answer this question. Other questions in the same request can still receive answers.

name: string or null
minLength0
type: "refusal"

The type of the object. Always refusal.

model: string
minLength0
usage: object { input_tokens, input_tokens_details, output_tokens, 2 more }
input_tokens: number
formatint64
minimum-2147483648
maximum2147483647
input_tokens_details: object { cache_write_tokens, cached_tokens }
cache_write_tokens: number
formatint64
minimum-2147483648
maximum2147483647
cached_tokens: number
formatint64
minimum-2147483648
maximum2147483647
output_tokens: number
formatint64
minimum-2147483648
maximum2147483647
output_tokens_details: object { reasoning_tokens }
reasoning_tokens: number
formatint64
minimum-2147483648
maximum2147483647
total_tokens: number
formatint64
minimum-2147483648
maximum2147483647
DecisionInputImage object { image_url, type, detail }

An inline image. External URLs and file IDs are not supported.

image_url: string

A base64-encoded image in a data URL.

minLength0
maxLength1073741824
type: "input_image"
detail: optional "low" or "high" or "auto" or "original" or null

The image detail level, using the selected model’s image profile. Defaults to auto.

One of the following:
"low"
"high"
"auto"
"original"
DecisionInputMessage object { content, role, type }

A user message containing text or inline images.

content: string or array of DecisionInputPart

Text evidence or an ordered list of text and inline image parts.

One of the following:
string
Parts = array of DecisionInputPart
One of the following:
DecisionInputText object { text, type }
text: string
minLength0
maxLength10485760
type: "input_text"
DecisionInputImage object { image_url, type, detail }

An inline image. External URLs and file IDs are not supported.

image_url: string

A base64-encoded image in a data URL.

minLength0
maxLength1073741824
type: "input_image"
detail: optional "low" or "high" or "auto" or "original" or null

The image detail level, using the selected model’s image profile. Defaults to auto.

One of the following:
"low"
"high"
"auto"
"original"
role: "user"
type: optional "message"
DecisionInputPart = DecisionInputText { text, type } or DecisionInputImage { image_url, type, detail }

An inline image. External URLs and file IDs are not supported.

One of the following:
DecisionInputText object { text, type }
text: string
minLength0
maxLength10485760
type: "input_text"
DecisionInputImage object { image_url, type, detail }

An inline image. External URLs and file IDs are not supported.

image_url: string

A base64-encoded image in a data URL.

minLength0
maxLength1073741824
type: "input_image"
detail: optional "low" or "high" or "auto" or "original" or null

The image detail level, using the selected model’s image profile. Defaults to auto.

One of the following:
"low"
"high"
"auto"
"original"
DecisionInputText object { text, type }
text: string
minLength0
maxLength10485760
type: "input_text"