Docs

Request Headers

authorizationstring*required

Authorization token (required).

Request Body

FunctionExecutionParamsInlineFunctionInlineProfileStreamingobject

Parameters for executing an inline function with an inline profile and streaming the response.

Properties
retry_tokenstringoptional

The retry token provided by a previous incomplete or failed function execution.

inputunion*required

The input provided to the function.

Variants
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

record
Values
Input

The input provided to the function.

array
Items
Input

The input provided to the function.

string
number
boolean
providerobjectoptional

Options for selecting the upstream provider of this completion.

Properties
data_collectionenumoptional

Specifies whether to allow providers which collect data.

Variants
"allow"
"deny"
zdrbooleanoptional

Whether to enforce Zero Data Retention (ZDR) policies when selecting providers.

sortenumoptional

Specifies the sorting strategy for provider selection.

Variants
"price"
"throughput"
"latency"
max_priceobjectoptional
Properties
promptnumberoptional

Maximum price for prompt tokens.

completionnumberoptional

Maximum price for completion tokens.

imagenumberoptional

Maximum price for image generation.

audionumberoptional

Maximum price for audio generation.

requestnumberoptional

Maximum price per request.

preferred_min_throughputnumberoptional

Preferred minimum throughput for the provider.

preferred_max_latencynumberoptional

Preferred maximum latency for the provider.

min_throughputnumberoptional

Minimum throughput for the provider.

max_latencynumberoptional

Maximum latency for the provider.

seedbigintoptional

If specified, upstream systems will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.

backoff_max_elapsed_timenumbermin: 0max: 4294967295optional

The maximum total time in milliseconds to spend on retries when a transient error occurs.

first_chunk_timeoutnumbermin: 0max: 4294967295optional

The maximum time in milliseconds to wait for the first chunk of a streaming response.

other_chunk_timeoutnumbermin: 0max: 4294967295optional

The maximum time in milliseconds to wait between subsequent chunks of a streaming response.

functionunion*required

A function.

Variants
ScalarFunctionobject

A scalar function.

Properties
type"scalar.function"*required
descriptionstring*required

The description of the scalar function.

changelogstringoptional

When present, describes changes from the previous version or versions.

input_schemaunion*required

An input schema defining the structure of function inputs.

Variants
object

An object input schema.

Properties
type"object"*required
descriptionstringoptional

The description of the object input.

propertiesrecord*required

The properties of the object input.

Values
InputSchema
requiredarrayoptional

The required properties of the object input.

Items
string
object

An array input schema.

Properties
type"array"*required
descriptionstringoptional

The description of the array input.

minItemsnumbermin: 0max: 4294967295optional

The minimum number of items in the array input.

maxItemsnumbermin: 0max: 4294967295optional

The maximum number of items in the array input.

items*required

The schema of the items in the array input.

object

A string input schema.

Properties
type"string"*required
descriptionstringoptional

The description of the string input.

enumarrayoptional

The enumeration of allowed string values.

Items
string
object

A number input schema.

Properties
type"number"*required
descriptionstringoptional

The description of the number input.

minimumnumberoptional

The minimum allowed value for the number input.

maximumnumberoptional

The maximum allowed value for the number input.

object

An integer input schema.

Properties
type"integer"*required
descriptionstringoptional

The description of the integer input.

minimumnumbermin: 0max: 4294967295optional

The minimum allowed value for the integer input.

maximumnumbermin: 0max: 4294967295optional

The maximum allowed value for the integer input.

object

A boolean input schema.

Properties
type"boolean"*required
descriptionstringoptional

The description of the boolean input.

object

An image input schema.

Properties
type"image"*required
descriptionstringoptional

The description of the image input.

object

An audio input schema.

Properties
type"audio"*required
descriptionstringoptional

The description of the audio input.

object

A video input schema.

Properties
type"video"*required
descriptionstringoptional

The description of the video input.

object

A file input schema.

Properties
type"file"*required
descriptionstringoptional

The description of the file input.

input_mapsunionoptional

An expression or list of expressions which evaluate to a 2D array of Inputs. Each sub-array will be fed into Tasks which specify an index of this input map.

Variants
Expressionobject

An expression which evaluates to a 2D array of Inputs.

Properties
$jmespathstring*required

A JMESPath expression.

array

A list of expressions which each evaluate to a 1D array of Inputs.

Items
Expressionobject

An expression which evaluates to a 1D array of Inputs.

Properties
$jmespathstring*required

A JMESPath expression.

tasksarray*required

The list of tasks to be executed as part of the function.

Items
object

A remote published scalar function task.

Properties
type"scalar.function"*required
ownerstring*required

The owner of the GitHub repository containing the function.

repositorystring*required

The name of the GitHub repository containing the function.

commitstring*required

The commit SHA of the GitHub repository containing the function.

skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

inputunion*required

The input provided to the function.

Variants
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

record
Values
InputExpression
array
Items
InputExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input.

Properties
$jmespathstring*required

A JMESPath expression.

object

A remote published vector function task.

Properties
type"vector.function"*required
ownerstring*required

The owner of the GitHub repository containing the function.

repositorystring*required

The name of the GitHub repository containing the function.

commitstring*required

The commit SHA of the GitHub repository containing the function.

skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

inputunion*required

The input provided to the function.

Variants
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

record
Values
InputExpression
array
Items
InputExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input.

Properties
$jmespathstring*required

A JMESPath expression.

object

A vector completion task.

Properties
type"vector.completion"*required
skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

messagesunion*required

A list of messages exchanged in a chat conversation.

Variants
MessageExpressionsarray

A list of messages exchanged in a chat conversation.

Items
DeveloperMessageExpressionobject

Developer-provided instructions that the model should follow, regardless of messages sent by the user.

Properties
role"developer"*required
contentunion*required

Simple content.

Variants
SimpleContentTextstring

Plain text content.

SimpleContentPartExpressionsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

Expressionobject

An expression which evaluates to a simple content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to simple content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

SystemMessageExpressionobject

Developer-provided instructions that the model should follow, regardless of messages sent by the user.

Properties
role"system"*required
contentunion*required

Simple content.

Variants
SimpleContentTextstring

Plain text content.

SimpleContentPartExpressionsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

Expressionobject

An expression which evaluates to a simple content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to simple content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

UserMessageExpressionobject

Messages sent by an end user, containing prompts or additional context information.

Properties
role"user"*required
contentunion*required

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

ToolMessageExpressionobject

Messages sent by tools in response to tool calls made by the assistant.

Properties
role"tool"*required
contentunion*required

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

tool_call_idunion*required

The ID of the tool call that this message is responding to.

Variants
ToolMessageToolCallIdstring

The ID of the tool call that this message is responding to.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

AssistantMessageExpressionobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

refusalunionoptional

The refusal message by the assistant.

Variants
AssistantMessageRefusalstring

The refusal message by the assistant.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

tool_callsunionoptional

Tool calls made by the assistant.

Variants
array

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionExpressionobject

A function tool call made by the assistant.

Properties
type"function"*required
idunion*required

The unique identifier for the tool call.

Variants
AssistantMessageToolCallIdstring

The unique identifier for the tool call.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

functionobject*required

The name and arguments of the function called.

Properties
nameunion*required

The name of the function called.

Variants
AssistantMessageToolCallFunctionNamestring

The name of the function called.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

argumentsunion*required

The arguments passed to the function.

Variants
AssistantMessageToolCallFunctionArgumentsstring

The arguments passed to the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a tool call.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of tool calls.

Properties
$jmespathstring*required

A JMESPath expression.

reasoningunionoptional

The reasoning provided by the assistant.

Variants
AssistantMessageReasoningstring

The reasoning provided by the assistant.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a message.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of messages.

Properties
$jmespathstring*required

A JMESPath expression.

toolsunionoptional

A list of tools that the assistant can call. These are readonly and will only be useful for explaining prior tool calls or otherwise influencing behavior.

Variants
ToolExpressionsarray

A list of tools that the assistant can call.

Items
FunctionToolExpressionobject

A function tool that the assistant can call.

Properties
type"function"*required
functionobject*required

The definition of a function tool.

Properties
nameunion*required

The name of the function.

Variants
FunctionToolNamestring

The name of the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

descriptionunionoptional

The description of the function.

Variants
FunctionToolDescriptionstring

The description of the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

parametersunionoptional

The JSON schema defining the parameters of the function.

Variants
record
Values
null
boolean
number
string
array
Items
JsonValueExpression

A JSON value.

record
Values
JsonValueExpression

A JSON value.

Expressionobject

An expression which evaluates to a JSON value.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a JSON schema object.

Properties
$jmespathstring*required

A JMESPath expression.

strictunionoptional

Whether to enforce strict adherence to the parameter schema.

Variants
FunctionToolStrictboolean

Whether to enforce strict adherence to the parameter schema.

Expressionobject

An expression which evaluates to a boolean.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a tool.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of tools.

Properties
$jmespathstring*required

A JMESPath expression.

responsesunion*required

A list of possible assistant responses which the LLMs in the Ensemble will vote on. The output scores will be of the same length, each corresponding to one response. The winner is the response with the highest score.

Variants
VectorResponseExpressionsarray

A list of possible assistant responses which the LLMs in the Ensemble will vote on. The output scores will be of the same length, each corresponding to one response. The winner is the response with the highest score.

Items
RichContentTextstring

Plain text content.

RichContentPartsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a possible assistant response.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of possible assistant responses.

Properties
$jmespathstring*required

A JMESPath expression.

outputobject*required

An expression which evaluates to a single number. This is the output of the scalar function. Will be provided with the outputs of all tasks.

Properties
$jmespathstring*required

A JMESPath expression.

VectorFunctionobject

A vector function.

Properties
type"vector.function"*required
descriptionstring*required

The description of the vector function.

changelogstringoptional

When present, describes changes from the previous version or versions.

input_schemaunion*required

An input schema defining the structure of function inputs.

Variants
object

An object input schema.

Properties
type"object"*required
descriptionstringoptional

The description of the object input.

propertiesrecord*required

The properties of the object input.

Values
InputSchema
requiredarrayoptional

The required properties of the object input.

Items
string
object

An array input schema.

Properties
type"array"*required
descriptionstringoptional

The description of the array input.

minItemsnumbermin: 0max: 4294967295optional

The minimum number of items in the array input.

maxItemsnumbermin: 0max: 4294967295optional

The maximum number of items in the array input.

items*required

The schema of the items in the array input.

object

A string input schema.

Properties
type"string"*required
descriptionstringoptional

The description of the string input.

enumarrayoptional

The enumeration of allowed string values.

Items
string
object

A number input schema.

Properties
type"number"*required
descriptionstringoptional

The description of the number input.

minimumnumberoptional

The minimum allowed value for the number input.

maximumnumberoptional

The maximum allowed value for the number input.

object

An integer input schema.

Properties
type"integer"*required
descriptionstringoptional

The description of the integer input.

minimumnumbermin: 0max: 4294967295optional

The minimum allowed value for the integer input.

maximumnumbermin: 0max: 4294967295optional

The maximum allowed value for the integer input.

object

A boolean input schema.

Properties
type"boolean"*required
descriptionstringoptional

The description of the boolean input.

object

An image input schema.

Properties
type"image"*required
descriptionstringoptional

The description of the image input.

object

An audio input schema.

Properties
type"audio"*required
descriptionstringoptional

The description of the audio input.

object

A video input schema.

Properties
type"video"*required
descriptionstringoptional

The description of the video input.

object

A file input schema.

Properties
type"file"*required
descriptionstringoptional

The description of the file input.

input_mapsunionoptional

An expression or list of expressions which evaluate to a 2D array of Inputs. Each sub-array will be fed into Tasks which specify an index of this input map.

Variants
Expressionobject

An expression which evaluates to a 2D array of Inputs.

Properties
$jmespathstring*required

A JMESPath expression.

array

A list of expressions which each evaluate to a 1D array of Inputs.

Items
Expressionobject

An expression which evaluates to a 1D array of Inputs.

Properties
$jmespathstring*required

A JMESPath expression.

tasksarray*required

The list of tasks to be executed as part of the function.

Items
object

A remote published scalar function task.

Properties
type"scalar.function"*required
ownerstring*required

The owner of the GitHub repository containing the function.

repositorystring*required

The name of the GitHub repository containing the function.

commitstring*required

The commit SHA of the GitHub repository containing the function.

skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

inputunion*required

The input provided to the function.

Variants
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

record
Values
InputExpression
array
Items
InputExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input.

Properties
$jmespathstring*required

A JMESPath expression.

object

A remote published vector function task.

Properties
type"vector.function"*required
ownerstring*required

The owner of the GitHub repository containing the function.

repositorystring*required

The name of the GitHub repository containing the function.

commitstring*required

The commit SHA of the GitHub repository containing the function.

skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

inputunion*required

The input provided to the function.

Variants
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

record
Values
InputExpression
array
Items
InputExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input.

Properties
$jmespathstring*required

A JMESPath expression.

object

A vector completion task.

Properties
type"vector.completion"*required
skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

messagesunion*required

A list of messages exchanged in a chat conversation.

Variants
MessageExpressionsarray

A list of messages exchanged in a chat conversation.

Items
DeveloperMessageExpressionobject

Developer-provided instructions that the model should follow, regardless of messages sent by the user.

Properties
role"developer"*required
contentunion*required

Simple content.

Variants
SimpleContentTextstring

Plain text content.

SimpleContentPartExpressionsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

Expressionobject

An expression which evaluates to a simple content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to simple content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

SystemMessageExpressionobject

Developer-provided instructions that the model should follow, regardless of messages sent by the user.

Properties
role"system"*required
contentunion*required

Simple content.

Variants
SimpleContentTextstring

Plain text content.

SimpleContentPartExpressionsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

Expressionobject

An expression which evaluates to a simple content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to simple content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

UserMessageExpressionobject

Messages sent by an end user, containing prompts or additional context information.

Properties
role"user"*required
contentunion*required

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

ToolMessageExpressionobject

Messages sent by tools in response to tool calls made by the assistant.

Properties
role"tool"*required
contentunion*required

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

tool_call_idunion*required

The ID of the tool call that this message is responding to.

Variants
ToolMessageToolCallIdstring

The ID of the tool call that this message is responding to.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

AssistantMessageExpressionobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

refusalunionoptional

The refusal message by the assistant.

Variants
AssistantMessageRefusalstring

The refusal message by the assistant.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

tool_callsunionoptional

Tool calls made by the assistant.

Variants
array

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionExpressionobject

A function tool call made by the assistant.

Properties
type"function"*required
idunion*required

The unique identifier for the tool call.

Variants
AssistantMessageToolCallIdstring

The unique identifier for the tool call.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

functionobject*required

The name and arguments of the function called.

Properties
nameunion*required

The name of the function called.

Variants
AssistantMessageToolCallFunctionNamestring

The name of the function called.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

argumentsunion*required

The arguments passed to the function.

Variants
AssistantMessageToolCallFunctionArgumentsstring

The arguments passed to the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a tool call.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of tool calls.

Properties
$jmespathstring*required

A JMESPath expression.

reasoningunionoptional

The reasoning provided by the assistant.

Variants
AssistantMessageReasoningstring

The reasoning provided by the assistant.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a message.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of messages.

Properties
$jmespathstring*required

A JMESPath expression.

toolsunionoptional

A list of tools that the assistant can call. These are readonly and will only be useful for explaining prior tool calls or otherwise influencing behavior.

Variants
ToolExpressionsarray

A list of tools that the assistant can call.

Items
FunctionToolExpressionobject

A function tool that the assistant can call.

Properties
type"function"*required
functionobject*required

The definition of a function tool.

Properties
nameunion*required

The name of the function.

Variants
FunctionToolNamestring

The name of the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

descriptionunionoptional

The description of the function.

Variants
FunctionToolDescriptionstring

The description of the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

parametersunionoptional

The JSON schema defining the parameters of the function.

Variants
record
Values
null
boolean
number
string
array
Items
JsonValueExpression

A JSON value.

record
Values
JsonValueExpression

A JSON value.

Expressionobject

An expression which evaluates to a JSON value.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a JSON schema object.

Properties
$jmespathstring*required

A JMESPath expression.

strictunionoptional

Whether to enforce strict adherence to the parameter schema.

Variants
FunctionToolStrictboolean

Whether to enforce strict adherence to the parameter schema.

Expressionobject

An expression which evaluates to a boolean.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a tool.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of tools.

Properties
$jmespathstring*required

A JMESPath expression.

responsesunion*required

A list of possible assistant responses which the LLMs in the Ensemble will vote on. The output scores will be of the same length, each corresponding to one response. The winner is the response with the highest score.

Variants
VectorResponseExpressionsarray

A list of possible assistant responses which the LLMs in the Ensemble will vote on. The output scores will be of the same length, each corresponding to one response. The winner is the response with the highest score.

Items
RichContentTextstring

Plain text content.

RichContentPartsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a possible assistant response.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of possible assistant responses.

Properties
$jmespathstring*required

A JMESPath expression.

outputobject*required

An expressions which evaluates to an array of numbers. This is the output of the vector function. Will be provided with the outputs of all tasks.

Properties
$jmespathstring*required

A JMESPath expression.

output_lengthunion*required

The length of the output vector.

Variants
numbermin: 0max: 4294967295

The fixed length of the output vector.

Expressionobject

An expression which evaluates to the length of the output vector. Will only be provided with the function input. The output length must be determinable from the input alone.

Properties
$jmespathstring*required

A JMESPath expression.

profileunion*required

A function profile where remote profiles may omit a commit.

Variants
object
Properties
ownerstring*required

The owner of the GitHub repository containing the profile.

repositorystring*required

The name of the GitHub repository containing the profile.

commitstringoptional

The commit SHA of the GitHub repository containing the profile.

ProfileCommitOptionalArray
streamtrue*required

Whether to stream the response as a series of chunks.

FunctionExecutionParamsInlineFunctionInlineProfileNonStreamingobject

Parameters for executing an inline function with an inline profile with a unary response.

Properties
retry_tokenstringoptional

The retry token provided by a previous incomplete or failed function execution.

inputunion*required

The input provided to the function.

Variants
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

record
Values
Input

The input provided to the function.

array
Items
Input

The input provided to the function.

string
number
boolean
providerobjectoptional

Options for selecting the upstream provider of this completion.

Properties
data_collectionenumoptional

Specifies whether to allow providers which collect data.

Variants
"allow"
"deny"
zdrbooleanoptional

Whether to enforce Zero Data Retention (ZDR) policies when selecting providers.

sortenumoptional

Specifies the sorting strategy for provider selection.

Variants
"price"
"throughput"
"latency"
max_priceobjectoptional
Properties
promptnumberoptional

Maximum price for prompt tokens.

completionnumberoptional

Maximum price for completion tokens.

imagenumberoptional

Maximum price for image generation.

audionumberoptional

Maximum price for audio generation.

requestnumberoptional

Maximum price per request.

preferred_min_throughputnumberoptional

Preferred minimum throughput for the provider.

preferred_max_latencynumberoptional

Preferred maximum latency for the provider.

min_throughputnumberoptional

Minimum throughput for the provider.

max_latencynumberoptional

Maximum latency for the provider.

seedbigintoptional

If specified, upstream systems will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.

backoff_max_elapsed_timenumbermin: 0max: 4294967295optional

The maximum total time in milliseconds to spend on retries when a transient error occurs.

first_chunk_timeoutnumbermin: 0max: 4294967295optional

The maximum time in milliseconds to wait for the first chunk of a streaming response.

other_chunk_timeoutnumbermin: 0max: 4294967295optional

The maximum time in milliseconds to wait between subsequent chunks of a streaming response.

functionunion*required

A function.

Variants
ScalarFunctionobject

A scalar function.

Properties
type"scalar.function"*required
descriptionstring*required

The description of the scalar function.

changelogstringoptional

When present, describes changes from the previous version or versions.

input_schemaunion*required

An input schema defining the structure of function inputs.

Variants
object

An object input schema.

Properties
type"object"*required
descriptionstringoptional

The description of the object input.

propertiesrecord*required

The properties of the object input.

Values
InputSchema
requiredarrayoptional

The required properties of the object input.

Items
string
object

An array input schema.

Properties
type"array"*required
descriptionstringoptional

The description of the array input.

minItemsnumbermin: 0max: 4294967295optional

The minimum number of items in the array input.

maxItemsnumbermin: 0max: 4294967295optional

The maximum number of items in the array input.

items*required

The schema of the items in the array input.

object

A string input schema.

Properties
type"string"*required
descriptionstringoptional

The description of the string input.

enumarrayoptional

The enumeration of allowed string values.

Items
string
object

A number input schema.

Properties
type"number"*required
descriptionstringoptional

The description of the number input.

minimumnumberoptional

The minimum allowed value for the number input.

maximumnumberoptional

The maximum allowed value for the number input.

object

An integer input schema.

Properties
type"integer"*required
descriptionstringoptional

The description of the integer input.

minimumnumbermin: 0max: 4294967295optional

The minimum allowed value for the integer input.

maximumnumbermin: 0max: 4294967295optional

The maximum allowed value for the integer input.

object

A boolean input schema.

Properties
type"boolean"*required
descriptionstringoptional

The description of the boolean input.

object

An image input schema.

Properties
type"image"*required
descriptionstringoptional

The description of the image input.

object

An audio input schema.

Properties
type"audio"*required
descriptionstringoptional

The description of the audio input.

object

A video input schema.

Properties
type"video"*required
descriptionstringoptional

The description of the video input.

object

A file input schema.

Properties
type"file"*required
descriptionstringoptional

The description of the file input.

input_mapsunionoptional

An expression or list of expressions which evaluate to a 2D array of Inputs. Each sub-array will be fed into Tasks which specify an index of this input map.

Variants
Expressionobject

An expression which evaluates to a 2D array of Inputs.

Properties
$jmespathstring*required

A JMESPath expression.

array

A list of expressions which each evaluate to a 1D array of Inputs.

Items
Expressionobject

An expression which evaluates to a 1D array of Inputs.

Properties
$jmespathstring*required

A JMESPath expression.

tasksarray*required

The list of tasks to be executed as part of the function.

Items
object

A remote published scalar function task.

Properties
type"scalar.function"*required
ownerstring*required

The owner of the GitHub repository containing the function.

repositorystring*required

The name of the GitHub repository containing the function.

commitstring*required

The commit SHA of the GitHub repository containing the function.

skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

inputunion*required

The input provided to the function.

Variants
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

record
Values
InputExpression
array
Items
InputExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input.

Properties
$jmespathstring*required

A JMESPath expression.

object

A remote published vector function task.

Properties
type"vector.function"*required
ownerstring*required

The owner of the GitHub repository containing the function.

repositorystring*required

The name of the GitHub repository containing the function.

commitstring*required

The commit SHA of the GitHub repository containing the function.

skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

inputunion*required

The input provided to the function.

Variants
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

record
Values
InputExpression
array
Items
InputExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input.

Properties
$jmespathstring*required

A JMESPath expression.

object

A vector completion task.

Properties
type"vector.completion"*required
skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

messagesunion*required

A list of messages exchanged in a chat conversation.

Variants
MessageExpressionsarray

A list of messages exchanged in a chat conversation.

Items
DeveloperMessageExpressionobject

Developer-provided instructions that the model should follow, regardless of messages sent by the user.

Properties
role"developer"*required
contentunion*required

Simple content.

Variants
SimpleContentTextstring

Plain text content.

SimpleContentPartExpressionsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

Expressionobject

An expression which evaluates to a simple content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to simple content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

SystemMessageExpressionobject

Developer-provided instructions that the model should follow, regardless of messages sent by the user.

Properties
role"system"*required
contentunion*required

Simple content.

Variants
SimpleContentTextstring

Plain text content.

SimpleContentPartExpressionsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

Expressionobject

An expression which evaluates to a simple content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to simple content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

UserMessageExpressionobject

Messages sent by an end user, containing prompts or additional context information.

Properties
role"user"*required
contentunion*required

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

ToolMessageExpressionobject

Messages sent by tools in response to tool calls made by the assistant.

Properties
role"tool"*required
contentunion*required

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

tool_call_idunion*required

The ID of the tool call that this message is responding to.

Variants
ToolMessageToolCallIdstring

The ID of the tool call that this message is responding to.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

AssistantMessageExpressionobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

refusalunionoptional

The refusal message by the assistant.

Variants
AssistantMessageRefusalstring

The refusal message by the assistant.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

tool_callsunionoptional

Tool calls made by the assistant.

Variants
array

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionExpressionobject

A function tool call made by the assistant.

Properties
type"function"*required
idunion*required

The unique identifier for the tool call.

Variants
AssistantMessageToolCallIdstring

The unique identifier for the tool call.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

functionobject*required

The name and arguments of the function called.

Properties
nameunion*required

The name of the function called.

Variants
AssistantMessageToolCallFunctionNamestring

The name of the function called.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

argumentsunion*required

The arguments passed to the function.

Variants
AssistantMessageToolCallFunctionArgumentsstring

The arguments passed to the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a tool call.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of tool calls.

Properties
$jmespathstring*required

A JMESPath expression.

reasoningunionoptional

The reasoning provided by the assistant.

Variants
AssistantMessageReasoningstring

The reasoning provided by the assistant.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a message.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of messages.

Properties
$jmespathstring*required

A JMESPath expression.

toolsunionoptional

A list of tools that the assistant can call. These are readonly and will only be useful for explaining prior tool calls or otherwise influencing behavior.

Variants
ToolExpressionsarray

A list of tools that the assistant can call.

Items
FunctionToolExpressionobject

A function tool that the assistant can call.

Properties
type"function"*required
functionobject*required

The definition of a function tool.

Properties
nameunion*required

The name of the function.

Variants
FunctionToolNamestring

The name of the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

descriptionunionoptional

The description of the function.

Variants
FunctionToolDescriptionstring

The description of the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

parametersunionoptional

The JSON schema defining the parameters of the function.

Variants
record
Values
null
boolean
number
string
array
Items
JsonValueExpression

A JSON value.

record
Values
JsonValueExpression

A JSON value.

Expressionobject

An expression which evaluates to a JSON value.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a JSON schema object.

Properties
$jmespathstring*required

A JMESPath expression.

strictunionoptional

Whether to enforce strict adherence to the parameter schema.

Variants
FunctionToolStrictboolean

Whether to enforce strict adherence to the parameter schema.

Expressionobject

An expression which evaluates to a boolean.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a tool.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of tools.

Properties
$jmespathstring*required

A JMESPath expression.

responsesunion*required

A list of possible assistant responses which the LLMs in the Ensemble will vote on. The output scores will be of the same length, each corresponding to one response. The winner is the response with the highest score.

Variants
VectorResponseExpressionsarray

A list of possible assistant responses which the LLMs in the Ensemble will vote on. The output scores will be of the same length, each corresponding to one response. The winner is the response with the highest score.

Items
RichContentTextstring

Plain text content.

RichContentPartsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a possible assistant response.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of possible assistant responses.

Properties
$jmespathstring*required

A JMESPath expression.

outputobject*required

An expression which evaluates to a single number. This is the output of the scalar function. Will be provided with the outputs of all tasks.

Properties
$jmespathstring*required

A JMESPath expression.

VectorFunctionobject

A vector function.

Properties
type"vector.function"*required
descriptionstring*required

The description of the vector function.

changelogstringoptional

When present, describes changes from the previous version or versions.

input_schemaunion*required

An input schema defining the structure of function inputs.

Variants
object

An object input schema.

Properties
type"object"*required
descriptionstringoptional

The description of the object input.

propertiesrecord*required

The properties of the object input.

Values
InputSchema
requiredarrayoptional

The required properties of the object input.

Items
string
object

An array input schema.

Properties
type"array"*required
descriptionstringoptional

The description of the array input.

minItemsnumbermin: 0max: 4294967295optional

The minimum number of items in the array input.

maxItemsnumbermin: 0max: 4294967295optional

The maximum number of items in the array input.

items*required

The schema of the items in the array input.

object

A string input schema.

Properties
type"string"*required
descriptionstringoptional

The description of the string input.

enumarrayoptional

The enumeration of allowed string values.

Items
string
object

A number input schema.

Properties
type"number"*required
descriptionstringoptional

The description of the number input.

minimumnumberoptional

The minimum allowed value for the number input.

maximumnumberoptional

The maximum allowed value for the number input.

object

An integer input schema.

Properties
type"integer"*required
descriptionstringoptional

The description of the integer input.

minimumnumbermin: 0max: 4294967295optional

The minimum allowed value for the integer input.

maximumnumbermin: 0max: 4294967295optional

The maximum allowed value for the integer input.

object

A boolean input schema.

Properties
type"boolean"*required
descriptionstringoptional

The description of the boolean input.

object

An image input schema.

Properties
type"image"*required
descriptionstringoptional

The description of the image input.

object

An audio input schema.

Properties
type"audio"*required
descriptionstringoptional

The description of the audio input.

object

A video input schema.

Properties
type"video"*required
descriptionstringoptional

The description of the video input.

object

A file input schema.

Properties
type"file"*required
descriptionstringoptional

The description of the file input.

input_mapsunionoptional

An expression or list of expressions which evaluate to a 2D array of Inputs. Each sub-array will be fed into Tasks which specify an index of this input map.

Variants
Expressionobject

An expression which evaluates to a 2D array of Inputs.

Properties
$jmespathstring*required

A JMESPath expression.

array

A list of expressions which each evaluate to a 1D array of Inputs.

Items
Expressionobject

An expression which evaluates to a 1D array of Inputs.

Properties
$jmespathstring*required

A JMESPath expression.

tasksarray*required

The list of tasks to be executed as part of the function.

Items
object

A remote published scalar function task.

Properties
type"scalar.function"*required
ownerstring*required

The owner of the GitHub repository containing the function.

repositorystring*required

The name of the GitHub repository containing the function.

commitstring*required

The commit SHA of the GitHub repository containing the function.

skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

inputunion*required

The input provided to the function.

Variants
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

record
Values
InputExpression
array
Items
InputExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input.

Properties
$jmespathstring*required

A JMESPath expression.

object

A remote published vector function task.

Properties
type"vector.function"*required
ownerstring*required

The owner of the GitHub repository containing the function.

repositorystring*required

The name of the GitHub repository containing the function.

commitstring*required

The commit SHA of the GitHub repository containing the function.

skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

inputunion*required

The input provided to the function.

Variants
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

record
Values
InputExpression
array
Items
InputExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input.

Properties
$jmespathstring*required

A JMESPath expression.

object

A vector completion task.

Properties
type"vector.completion"*required
skipobjectoptional

An expression which evaluates to a boolean indicating whether to skip this task.

Properties
$jmespathstring*required

A JMESPath expression.

mapnumbermin: 0max: 4294967295optional

If present, indicates that this task should be ran once for each entry in the specified input map (input map is a 2D array indexed by this value).

messagesunion*required

A list of messages exchanged in a chat conversation.

Variants
MessageExpressionsarray

A list of messages exchanged in a chat conversation.

Items
DeveloperMessageExpressionobject

Developer-provided instructions that the model should follow, regardless of messages sent by the user.

Properties
role"developer"*required
contentunion*required

Simple content.

Variants
SimpleContentTextstring

Plain text content.

SimpleContentPartExpressionsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

Expressionobject

An expression which evaluates to a simple content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to simple content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

SystemMessageExpressionobject

Developer-provided instructions that the model should follow, regardless of messages sent by the user.

Properties
role"system"*required
contentunion*required

Simple content.

Variants
SimpleContentTextstring

Plain text content.

SimpleContentPartExpressionsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

Expressionobject

An expression which evaluates to a simple content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to simple content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

UserMessageExpressionobject

Messages sent by an end user, containing prompts or additional context information.

Properties
role"user"*required
contentunion*required

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

ToolMessageExpressionobject

Messages sent by tools in response to tool calls made by the assistant.

Properties
role"tool"*required
contentunion*required

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

tool_call_idunion*required

The ID of the tool call that this message is responding to.

Variants
ToolMessageToolCallIdstring

The ID of the tool call that this message is responding to.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

AssistantMessageExpressionobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
RichContentTextstring

Plain text content.

RichContentPartExpressionsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a rich content part.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to rich content.

Properties
$jmespathstring*required

A JMESPath expression.

nameunionoptional

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Variants
MessageNamestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

refusalunionoptional

The refusal message by the assistant.

Variants
AssistantMessageRefusalstring

The refusal message by the assistant.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

tool_callsunionoptional

Tool calls made by the assistant.

Variants
array

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionExpressionobject

A function tool call made by the assistant.

Properties
type"function"*required
idunion*required

The unique identifier for the tool call.

Variants
AssistantMessageToolCallIdstring

The unique identifier for the tool call.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

functionobject*required

The name and arguments of the function called.

Properties
nameunion*required

The name of the function called.

Variants
AssistantMessageToolCallFunctionNamestring

The name of the function called.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

argumentsunion*required

The arguments passed to the function.

Variants
AssistantMessageToolCallFunctionArgumentsstring

The arguments passed to the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a tool call.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of tool calls.

Properties
$jmespathstring*required

A JMESPath expression.

reasoningunionoptional

The reasoning provided by the assistant.

Variants
AssistantMessageReasoningstring

The reasoning provided by the assistant.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a message.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of messages.

Properties
$jmespathstring*required

A JMESPath expression.

toolsunionoptional

A list of tools that the assistant can call. These are readonly and will only be useful for explaining prior tool calls or otherwise influencing behavior.

Variants
ToolExpressionsarray

A list of tools that the assistant can call.

Items
FunctionToolExpressionobject

A function tool that the assistant can call.

Properties
type"function"*required
functionobject*required

The definition of a function tool.

Properties
nameunion*required

The name of the function.

Variants
FunctionToolNamestring

The name of the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

descriptionunionoptional

The description of the function.

Variants
FunctionToolDescriptionstring

The description of the function.

Expressionobject

An expression which evaluates to a string.

Properties
$jmespathstring*required

A JMESPath expression.

parametersunionoptional

The JSON schema defining the parameters of the function.

Variants
record
Values
null
boolean
number
string
array
Items
JsonValueExpression

A JSON value.

record
Values
JsonValueExpression

A JSON value.

Expressionobject

An expression which evaluates to a JSON value.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a JSON schema object.

Properties
$jmespathstring*required

A JMESPath expression.

strictunionoptional

Whether to enforce strict adherence to the parameter schema.

Variants
FunctionToolStrictboolean

Whether to enforce strict adherence to the parameter schema.

Expressionobject

An expression which evaluates to a boolean.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to a tool.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of tools.

Properties
$jmespathstring*required

A JMESPath expression.

responsesunion*required

A list of possible assistant responses which the LLMs in the Ensemble will vote on. The output scores will be of the same length, each corresponding to one response. The winner is the response with the highest score.

Variants
VectorResponseExpressionsarray

A list of possible assistant responses which the LLMs in the Ensemble will vote on. The output scores will be of the same length, each corresponding to one response. The winner is the response with the highest score.

Items
RichContentTextstring

Plain text content.

RichContentPartsarray

An array of rich content parts.

Items
TextRichContentPartobject

A text rich content part.

Properties
type"text"*required
textstring*required

The text content.

ImageRichContentPartobject

An image rich content part.

Properties
type"image_url"*required
image_urlobject*required

The URL of the image and its optional detail level.

Properties
urlstring*required

Either a URL of the image or the base64 encoded image data.

detailenumoptional

Specifies the detail level of the image.

Variants
"auto"
"low"
"high"
AudioRichContentPartobject

An audio rich content part.

Properties
type"input_audio"*required
input_audioobject*required

The audio data and its format.

Properties
datastring*required

Base64 encoded audio data.

formatenum*required

The format of the encoded audio data.

Variants
"wav"
"mp3"
VideoRichContentPartobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlobject*required
Properties
urlstring*required

URL of the video.

FileRichContentPartobject

A file rich content part.

Properties
type"file"*required
fileobject*required

The file to be used as input, either as base64 data, an uploaded file ID, or a URL.

Properties
file_datastringoptional

The base64 encoded file data, used when passing the file to the model as a string.

file_idstringoptional

The ID of an uploaded file to use as input.

filenamestringoptional

The name of the file, used when passing the file to the model as a string.

file_urlstringoptional

The URL of the file, used when passing the file to the model as a URL.

Expressionobject

An expression which evaluates to a possible assistant response.

Properties
$jmespathstring*required

A JMESPath expression.

Expressionobject

An expression which evaluates to an array of possible assistant responses.

Properties
$jmespathstring*required

A JMESPath expression.

outputobject*required

An expressions which evaluates to an array of numbers. This is the output of the vector function. Will be provided with the outputs of all tasks.

Properties
$jmespathstring*required

A JMESPath expression.

output_lengthunion*required

The length of the output vector.

Variants
numbermin: 0max: 4294967295

The fixed length of the output vector.

Expressionobject

An expression which evaluates to the length of the output vector. Will only be provided with the function input. The output length must be determinable from the input alone.

Properties
$jmespathstring*required

A JMESPath expression.

profileunion*required

A function profile where remote profiles may omit a commit.

Variants
object
Properties
ownerstring*required

The owner of the GitHub repository containing the profile.

repositorystring*required

The name of the GitHub repository containing the profile.

commitstringoptional

The commit SHA of the GitHub repository containing the profile.

ProfileCommitOptionalArray
streamfalseoptional

Whether to stream the response as a series of chunks.

Response Body

idstring*required

The unique identifier of the function execution.

tasksarray*required

The tasks executed as part of the function execution.

Items
object

A function execution task.

Properties
idstring*required

The unique identifier of the function execution.

tasksarray*required

The tasks executed as part of the function execution.

tasks_errorsboolean*required

When true, indicates that one or more tasks encountered errors during execution.

outputunion*required

The output of the function execution.

Variants
number

The scalar output of the function execution.

array

The vector output of the function execution.

Items
number
null
boolean
number
string
array
Items
JsonValue

A JSON value.

record
Values
JsonValue

A JSON value.

errorobjectoptional

When non-null, indicates that an error occurred during the function execution.

Properties
codenumbermin: 0max: 4294967295*required

The status code of the error.

messageany*required

The message or details of the error.

retry_tokenstringoptional

A token which may be used to retry the function execution.

creatednumbermin: 0max: 4294967295*required

The UNIX timestamp (in seconds) when the function execution chunk was created.

functionstringoptional

The unique identifier of the function being executed.

profilestringoptional

The unique identifier of the profile being used.

objectenum*required

The object type.

Variants
"scalar.function.execution"
"vector.function.execution"
usageobject*required

Token and cost usage statistics for the completion.

Properties
completion_tokensnumbermin: 0max: 4294967295*required

The number of tokens generated in the completion.

prompt_tokensnumbermin: 0max: 4294967295*required

The number of tokens in the prompt.

total_tokensnumbermin: 0max: 4294967295*required

The total number of tokens used in the prompt or generated in the completion.

completion_tokens_detailsobjectoptional

Detailed breakdown of generated completion tokens.

Properties
accepted_prediction_tokensnumbermin: 0max: 4294967295optional

The number of accepted prediction tokens in the completion.

audio_tokensnumbermin: 0max: 4294967295optional

The number of generated audio tokens in the completion.

reasoning_tokensnumbermin: 0max: 4294967295optional

The number of generated reasoning tokens in the completion.

rejected_prediction_tokensnumbermin: 0max: 4294967295optional

The number of rejected prediction tokens in the completion.

prompt_tokens_detailsobjectoptional

Detailed breakdown of prompt tokens.

Properties
audio_tokensnumbermin: 0max: 4294967295optional

The number of audio tokens in the prompt.

cached_tokensnumbermin: 0max: 4294967295optional

The number of cached tokens in the prompt.

cache_write_tokensnumbermin: 0max: 4294967295optional

The number of prompt tokens written to cache.

video_tokensnumbermin: 0max: 4294967295optional

The number of video tokens in the prompt.

costnumber*required

The cost in credits incurred for this completion.

cost_detailsobjectoptional

Detailed breakdown of upstream costs incurred.

Properties
upstream_inference_costnumberoptional

The cost incurred upstream.

upstream_upstream_inference_costnumberoptional

The cost incurred by upstream's upstream.

total_costnumber*required

The total cost in credits incurred including upstream costs.

indexnumbermin: 0max: 4294967295*required

The index of the task in the sequence of tasks.

task_indexnumbermin: 0max: 4294967295*required

The index of the task amongst all mapped and non-skipped compiled tasks. Used internally.

task_patharray*required

The path of this task which may be used to navigate which nested task this is amongst the root functions tasks and sub-tasks.

Items
numbermin: 0max: 4294967295
object

A vector completion task.

Properties
idstring*required

The unique identifier of the vector completion.

completionsarray*required

The list of chat completions created for this vector completion.

Items
object

A chat completion generated in the pursuit of a vector completion.

Properties
idstring*required

The unique identifier of the chat completion.

upstream_idstring*required

The unique identifier of the upstream chat completion.

choicesarray*required

The list of choices in this chat completion.

Items
object

A choice in a unary chat completion response.

Properties
messageobject*required

A message generated by the assistant.

Properties
contentstringoptional

The content of the message.

refusalstringoptional

The refusal message, if any.

roleenum*required

The role of the message author.

Variants
"assistant"
tool_callsarrayoptional

The tool calls made by the assistant, if any.

Items
object

A function tool call made by the assistant.

Properties
type"function"*required
idstring*required

The unique identifier of the function tool.

functionobject*required
Properties
namestring*required

The name of the function.

argumentsstring*required

The arguments passed to the function.

reasoningstringoptional

The reasoning provided by the assistant, if any.

imagesarrayoptional

The images generated by the assistant, if any.

Items
object
Properties
type"image_url"*required
image_urlobject*required
Properties
urlstring*required

The Base64 URL of the generated image.

finish_reasonenum*required

The reason why the assistant ceased to generate further tokens.

Variants
"stop"
"length"
"tool_calls"
"content_filter"
"error"
indexnumbermin: 0max: 4294967295*required

The index of the choice in the list of choices.

logprobsobjectoptional

The log probabilities of the tokens generated by the model.

Properties
contentarrayoptional

The log probabilities of the tokens in the content.

Items
object

The token which was selected by the sampler for this position as well as the logprobabilities of the top options.

Properties
tokenstring*required

The token string which was selected by the sampler.

bytesarrayoptional

The byte representation of the token which was selected by the sampler.

Items
numbermin: 0max: 4294967295
logprobnumber*required

The log probability of the token which was selected by the sampler.

top_logprobsarray*required

The log probabilities of the top tokens for this position.

Items
object

The log probability of a token in the list of top tokens.

Properties
tokenstring*required

The token string.

bytesarrayoptional

The byte representation of the token.

Items
numbermin: 0max: 4294967295
logprobnumberoptional

The log probability of the token.

refusalarrayoptional

The log probabilities of the tokens in the refusal.

Items
object

The token which was selected by the sampler for this position as well as the logprobabilities of the top options.

Properties
tokenstring*required

The token string which was selected by the sampler.

bytesarrayoptional

The byte representation of the token which was selected by the sampler.

Items
numbermin: 0max: 4294967295
logprobnumber*required

The log probability of the token which was selected by the sampler.

top_logprobsarray*required

The log probabilities of the top tokens for this position.

Items
object

The log probability of a token in the list of top tokens.

Properties
tokenstring*required

The token string.

bytesarrayoptional

The byte representation of the token.

Items
numbermin: 0max: 4294967295
logprobnumberoptional

The log probability of the token.

creatednumbermin: 0max: 4294967295*required

The Unix timestamp (in seconds) when the chat completion was created.

modelstring*required

The unique identifier of the Ensemble LLM used for this chat completion.

upstream_modelstring*required

The upstream model used for this chat completion.

object"chat.completion"*required
service_tierstringoptional
system_fingerprintstringoptional
usageobject*required

Token and cost usage statistics for the completion.

Properties
completion_tokensnumbermin: 0max: 4294967295*required

The number of tokens generated in the completion.

prompt_tokensnumbermin: 0max: 4294967295*required

The number of tokens in the prompt.

total_tokensnumbermin: 0max: 4294967295*required

The total number of tokens used in the prompt or generated in the completion.

completion_tokens_detailsobjectoptional

Detailed breakdown of generated completion tokens.

Properties
accepted_prediction_tokensnumbermin: 0max: 4294967295optional

The number of accepted prediction tokens in the completion.

audio_tokensnumbermin: 0max: 4294967295optional

The number of generated audio tokens in the completion.

reasoning_tokensnumbermin: 0max: 4294967295optional

The number of generated reasoning tokens in the completion.

rejected_prediction_tokensnumbermin: 0max: 4294967295optional

The number of rejected prediction tokens in the completion.

prompt_tokens_detailsobjectoptional

Detailed breakdown of prompt tokens.

Properties
audio_tokensnumbermin: 0max: 4294967295optional

The number of audio tokens in the prompt.

cached_tokensnumbermin: 0max: 4294967295optional

The number of cached tokens in the prompt.

cache_write_tokensnumbermin: 0max: 4294967295optional

The number of prompt tokens written to cache.

video_tokensnumbermin: 0max: 4294967295optional

The number of video tokens in the prompt.

costnumber*required

The cost in credits incurred for this completion.

cost_detailsobjectoptional

Detailed breakdown of upstream costs incurred.

Properties
upstream_inference_costnumberoptional

The cost incurred upstream.

upstream_upstream_inference_costnumberoptional

The cost incurred by upstream's upstream.

total_costnumber*required

The total cost in credits incurred including upstream costs.

cost_multipliernumber*required

The cost multiplier applied to upstream costs for computing ObjectiveAI costs.

is_byokboolean*required

Whether the completion used a BYOK (Bring Your Own Key) API Key.

providerstringoptional

The provider used for this chat completion.

indexnumbermin: 0max: 4294967295*required

The index of the completion amongst all chat completions.

errorobjectoptional

An error encountered during the generation of this chat completion.

Properties
codenumbermin: 0max: 4294967295*required

The status code of the error.

messageany*required

The message or details of the error.

votesarray*required

The list of votes for responses in the request from the Ensemble LLMs within the provided Ensemble.

Items
object

A vote from an Ensemble LLM within a Vector Completion.

Properties
modelstring*required

The unique identifier of the Ensemble LLM which generated this vote.

ensemble_indexnumbermin: 0max: 4294967295*required

The index of the Ensemble LLM in the Ensemble.

flat_ensemble_indexnumbermin: 0max: 4294967295*required

The flat index of the Ensemble LLM in the expanded Ensemble, accounting for counts.

votearray*required

The vote generated by this Ensemble LLM. It is of the same length of the number of responses provided in the request. If the Ensemble LLM used logprobs, may be a probability distribution; otherwise, one of the responses will have a value of 1 and the rest 0.

Items
number
weightnumber*required

The weight assigned to this vote.

retrybooleanoptional

Whether this vote came from a previous Vector Completion which was retried.

scoresarray*required

The scores for each response in the request, aggregated from the votes of the Ensemble LLMs.

Items
number
weightsarray*required

The weights assigned to each response in the request, aggregated from the votes of the Ensemble LLMs.

Items
number
creatednumbermin: 0max: 4294967295*required

The Unix timestamp (in seconds) when the vector completion was created.

ensemblestring*required

The unique identifier of the Ensemble used for this vector completion.

object"vector.completion"*required
usageobject*required

Token and cost usage statistics for the completion.

Properties
completion_tokensnumbermin: 0max: 4294967295*required

The number of tokens generated in the completion.

prompt_tokensnumbermin: 0max: 4294967295*required

The number of tokens in the prompt.

total_tokensnumbermin: 0max: 4294967295*required

The total number of tokens used in the prompt or generated in the completion.

completion_tokens_detailsobjectoptional

Detailed breakdown of generated completion tokens.

Properties
accepted_prediction_tokensnumbermin: 0max: 4294967295optional

The number of accepted prediction tokens in the completion.

audio_tokensnumbermin: 0max: 4294967295optional

The number of generated audio tokens in the completion.

reasoning_tokensnumbermin: 0max: 4294967295optional

The number of generated reasoning tokens in the completion.

rejected_prediction_tokensnumbermin: 0max: 4294967295optional

The number of rejected prediction tokens in the completion.

prompt_tokens_detailsobjectoptional

Detailed breakdown of prompt tokens.

Properties
audio_tokensnumbermin: 0max: 4294967295optional

The number of audio tokens in the prompt.

cached_tokensnumbermin: 0max: 4294967295optional

The number of cached tokens in the prompt.

cache_write_tokensnumbermin: 0max: 4294967295optional

The number of prompt tokens written to cache.

video_tokensnumbermin: 0max: 4294967295optional

The number of video tokens in the prompt.

costnumber*required

The cost in credits incurred for this completion.

cost_detailsobjectoptional

Detailed breakdown of upstream costs incurred.

Properties
upstream_inference_costnumberoptional

The cost incurred upstream.

upstream_upstream_inference_costnumberoptional

The cost incurred by upstream's upstream.

total_costnumber*required

The total cost in credits incurred including upstream costs.

indexnumbermin: 0max: 4294967295*required

The index of the task in the sequence of tasks.

task_indexnumbermin: 0max: 4294967295*required

The index of the task amongst all mapped and non-skipped compiled tasks. Used internally.

task_patharray*required

The path of this task which may be used to navigate which nested task this is amongst the root functions tasks and sub-tasks.

Items
numbermin: 0max: 4294967295
errorobjectoptional

When non-null, indicates that an error occurred during the vector completion task.

Properties
codenumbermin: 0max: 4294967295*required

The status code of the error.

messageany*required

The message or details of the error.

tasks_errorsboolean*required

When true, indicates that one or more tasks encountered errors during execution.

outputunion*required

The output of the function execution.

Variants
number

The scalar output of the function execution.

array

The vector output of the function execution.

Items
number
null
boolean
number
string
array
Items
JsonValue

A JSON value.

record
Values
JsonValue

A JSON value.

errorobjectoptional

When non-null, indicates that an error occurred during the function execution.

Properties
codenumbermin: 0max: 4294967295*required

The status code of the error.

messageany*required

The message or details of the error.

retry_tokenstringoptional

A token which may be used to retry the function execution.

creatednumbermin: 0max: 4294967295*required

The UNIX timestamp (in seconds) when the function execution chunk was created.

functionstringoptional

The unique identifier of the function being executed.

profilestringoptional

The unique identifier of the profile being used.

objectenum*required

The object type.

Variants
"scalar.function.execution"
"vector.function.execution"
usageobject*required

Token and cost usage statistics for the completion.

Properties
completion_tokensnumbermin: 0max: 4294967295*required

The number of tokens generated in the completion.

prompt_tokensnumbermin: 0max: 4294967295*required

The number of tokens in the prompt.

total_tokensnumbermin: 0max: 4294967295*required

The total number of tokens used in the prompt or generated in the completion.

completion_tokens_detailsobjectoptional

Detailed breakdown of generated completion tokens.

Properties
accepted_prediction_tokensnumbermin: 0max: 4294967295optional

The number of accepted prediction tokens in the completion.

audio_tokensnumbermin: 0max: 4294967295optional

The number of generated audio tokens in the completion.

reasoning_tokensnumbermin: 0max: 4294967295optional

The number of generated reasoning tokens in the completion.

rejected_prediction_tokensnumbermin: 0max: 4294967295optional

The number of rejected prediction tokens in the completion.

prompt_tokens_detailsobjectoptional

Detailed breakdown of prompt tokens.

Properties
audio_tokensnumbermin: 0max: 4294967295optional

The number of audio tokens in the prompt.

cached_tokensnumbermin: 0max: 4294967295optional

The number of cached tokens in the prompt.

cache_write_tokensnumbermin: 0max: 4294967295optional

The number of prompt tokens written to cache.

video_tokensnumbermin: 0max: 4294967295optional

The number of video tokens in the prompt.

costnumber*required

The cost in credits incurred for this completion.

cost_detailsobjectoptional

Detailed breakdown of upstream costs incurred.

Properties
upstream_inference_costnumberoptional

The cost incurred upstream.

upstream_upstream_inference_costnumberoptional

The cost incurred by upstream's upstream.

total_costnumber*required

The total cost in credits incurred including upstream costs.

Response Body (Streaming)

idstring*required

The unique identifier of the function execution.

tasksarray*required

The tasks executed as part of the function execution.

Items
object

A chunk of a function execution task.

Properties
idstring*required

The unique identifier of the function execution.

tasksarray*required

The tasks executed as part of the function execution.

tasks_errorsbooleanoptional

When true, indicates that one or more tasks encountered errors during execution.

outputunionoptional

The output of the function execution.

Variants
number

The scalar output of the function execution.

array

The vector output of the function execution.

Items
number
null
boolean
number
string
array
Items
JsonValue

A JSON value.

record
Values
JsonValue

A JSON value.

errorobjectoptional

When present, indicates that an error occurred during the function execution.

Properties
codenumbermin: 0max: 4294967295*required

The status code of the error.

messageany*required

The message or details of the error.

retry_tokenstringoptional

A token which may be used to retry the function execution.

creatednumbermin: 0max: 4294967295*required

The UNIX timestamp (in seconds) when the function execution chunk was created.

functionstringoptional

The unique identifier of the function being executed.

profilestringoptional

The unique identifier of the profile being used.

objectenum*required

The object type.

Variants
"scalar.function.execution.chunk"
"vector.function.execution.chunk"
usageobjectoptional

Token and cost usage statistics for the completion.

Properties
completion_tokensnumbermin: 0max: 4294967295*required

The number of tokens generated in the completion.

prompt_tokensnumbermin: 0max: 4294967295*required

The number of tokens in the prompt.

total_tokensnumbermin: 0max: 4294967295*required

The total number of tokens used in the prompt or generated in the completion.

completion_tokens_detailsobjectoptional

Detailed breakdown of generated completion tokens.

Properties
accepted_prediction_tokensnumbermin: 0max: 4294967295optional

The number of accepted prediction tokens in the completion.

audio_tokensnumbermin: 0max: 4294967295optional

The number of generated audio tokens in the completion.

reasoning_tokensnumbermin: 0max: 4294967295optional

The number of generated reasoning tokens in the completion.

rejected_prediction_tokensnumbermin: 0max: 4294967295optional

The number of rejected prediction tokens in the completion.

prompt_tokens_detailsobjectoptional

Detailed breakdown of prompt tokens.

Properties
audio_tokensnumbermin: 0max: 4294967295optional

The number of audio tokens in the prompt.

cached_tokensnumbermin: 0max: 4294967295optional

The number of cached tokens in the prompt.

cache_write_tokensnumbermin: 0max: 4294967295optional

The number of prompt tokens written to cache.

video_tokensnumbermin: 0max: 4294967295optional

The number of video tokens in the prompt.

costnumber*required

The cost in credits incurred for this completion.

cost_detailsobjectoptional

Detailed breakdown of upstream costs incurred.

Properties
upstream_inference_costnumberoptional

The cost incurred upstream.

upstream_upstream_inference_costnumberoptional

The cost incurred by upstream's upstream.

total_costnumber*required

The total cost in credits incurred including upstream costs.

indexnumbermin: 0max: 4294967295*required

The index of the task in the sequence of tasks.

task_indexnumbermin: 0max: 4294967295*required

The index of the task amongst all mapped and non-skipped compiled tasks. Used internally.

task_patharray*required

The path of this task which may be used to navigate which nested task this is amongst the root functions tasks and sub-tasks.

Items
numbermin: 0max: 4294967295
object

A chunk of a vector completion task.

Properties
idstring*required

The unique identifier of the vector completion.

completionsarray*required

The list of chat completion chunks created for this vector completion.

Items
object

A chat completion chunk generated in the pursuit of a vector completion.

Properties
idstring*required

The unique identifier of the chat completion.

upstream_idstring*required

The unique identifier of the upstream chat completion.

choicesarray*required

The list of choices in this chunk.

Items
object

A choice in a streaming chat completion response.

Properties
deltaobject*required

A delta in a streaming chat completion response.

Properties
contentstringoptional

The content added in this delta.

refusalstringoptional

The refusal message added in this delta.

roleenumoptional

The role of the message author.

Variants
"assistant"
tool_callsarrayoptional

Tool calls made in this delta.

Items
object

A function tool call made by the assistant.

Properties
indexnumbermin: 0max: 4294967295*required

The index of the tool call in the sequence of tool calls.

type"function"optional
idstringoptional

The unique identifier of the function tool.

functionobjectoptional
Properties
namestringoptional

The name of the function.

argumentsstringoptional

The arguments passed to the function.

reasoningstringoptional

The reasoning added in this delta.

imagesarrayoptional

Images added in this delta.

Items
object
Properties
type"image_url"*required
image_urlobject*required
Properties
urlstring*required

The Base64 URL of the generated image.

finish_reasonenumoptional

The reason why the assistant ceased to generate further tokens.

Variants
"stop"
"length"
"tool_calls"
"content_filter"
"error"
indexnumbermin: 0max: 4294967295*required

The index of the choice in the list of choices.

logprobsobjectoptional

The log probabilities of the tokens generated by the model.

Properties
contentarrayoptional

The log probabilities of the tokens in the content.

Items
object

The token which was selected by the sampler for this position as well as the logprobabilities of the top options.

Properties
tokenstring*required

The token string which was selected by the sampler.

bytesarrayoptional

The byte representation of the token which was selected by the sampler.

Items
numbermin: 0max: 4294967295
logprobnumber*required

The log probability of the token which was selected by the sampler.

top_logprobsarray*required

The log probabilities of the top tokens for this position.

Items
object

The log probability of a token in the list of top tokens.

Properties
tokenstring*required

The token string.

bytesarrayoptional

The byte representation of the token.

Items
numbermin: 0max: 4294967295
logprobnumberoptional

The log probability of the token.

refusalarrayoptional

The log probabilities of the tokens in the refusal.

Items
object

The token which was selected by the sampler for this position as well as the logprobabilities of the top options.

Properties
tokenstring*required

The token string which was selected by the sampler.

bytesarrayoptional

The byte representation of the token which was selected by the sampler.

Items
numbermin: 0max: 4294967295
logprobnumber*required

The log probability of the token which was selected by the sampler.

top_logprobsarray*required

The log probabilities of the top tokens for this position.

Items
object

The log probability of a token in the list of top tokens.

Properties
tokenstring*required

The token string.

bytesarrayoptional

The byte representation of the token.

Items
numbermin: 0max: 4294967295
logprobnumberoptional

The log probability of the token.

creatednumbermin: 0max: 4294967295*required

The Unix timestamp (in seconds) when the chat completion was created.

modelstring*required

The unique identifier of the Ensemble LLM used for this chat completion.

upstream_modelstring*required

The upstream model used for this chat completion.

object"chat.completion.chunk"*required
service_tierstringoptional
system_fingerprintstringoptional
usageobjectoptional

Token and cost usage statistics for the completion.

Properties
completion_tokensnumbermin: 0max: 4294967295*required

The number of tokens generated in the completion.

prompt_tokensnumbermin: 0max: 4294967295*required

The number of tokens in the prompt.

total_tokensnumbermin: 0max: 4294967295*required

The total number of tokens used in the prompt or generated in the completion.

completion_tokens_detailsobjectoptional

Detailed breakdown of generated completion tokens.

Properties
accepted_prediction_tokensnumbermin: 0max: 4294967295optional

The number of accepted prediction tokens in the completion.

audio_tokensnumbermin: 0max: 4294967295optional

The number of generated audio tokens in the completion.

reasoning_tokensnumbermin: 0max: 4294967295optional

The number of generated reasoning tokens in the completion.

rejected_prediction_tokensnumbermin: 0max: 4294967295optional

The number of rejected prediction tokens in the completion.

prompt_tokens_detailsobjectoptional

Detailed breakdown of prompt tokens.

Properties
audio_tokensnumbermin: 0max: 4294967295optional

The number of audio tokens in the prompt.

cached_tokensnumbermin: 0max: 4294967295optional

The number of cached tokens in the prompt.

cache_write_tokensnumbermin: 0max: 4294967295optional

The number of prompt tokens written to cache.

video_tokensnumbermin: 0max: 4294967295optional

The number of video tokens in the prompt.

costnumber*required

The cost in credits incurred for this completion.

cost_detailsobjectoptional

Detailed breakdown of upstream costs incurred.

Properties
upstream_inference_costnumberoptional

The cost incurred upstream.

upstream_upstream_inference_costnumberoptional

The cost incurred by upstream's upstream.

total_costnumber*required

The total cost in credits incurred including upstream costs.

cost_multipliernumber*required

The cost multiplier applied to upstream costs for computing ObjectiveAI costs.

is_byokboolean*required

Whether the completion used a BYOK (Bring Your Own Key) API Key.

providerstringoptional

The provider used for this chat completion.

indexnumbermin: 0max: 4294967295*required

The index of the completion amongst all chat completions.

errorobjectoptional

An error encountered during the generation of this chat completion.

Properties
codenumbermin: 0max: 4294967295*required

The status code of the error.

messageany*required

The message or details of the error.

votesarray*required

The list of votes for responses in the request from the Ensemble LLMs within the provided Ensemble.

Items
object

A vote from an Ensemble LLM within a Vector Completion.

Properties
modelstring*required

The unique identifier of the Ensemble LLM which generated this vote.

ensemble_indexnumbermin: 0max: 4294967295*required

The index of the Ensemble LLM in the Ensemble.

flat_ensemble_indexnumbermin: 0max: 4294967295*required

The flat index of the Ensemble LLM in the expanded Ensemble, accounting for counts.

votearray*required

The vote generated by this Ensemble LLM. It is of the same length of the number of responses provided in the request. If the Ensemble LLM used logprobs, may be a probability distribution; otherwise, one of the responses will have a value of 1 and the rest 0.

Items
number
weightnumber*required

The weight assigned to this vote.

retrybooleanoptional

Whether this vote came from a previous Vector Completion which was retried.

scoresarray*required

The scores for each response in the request, aggregated from the votes of the Ensemble LLMs.

Items
number
weightsarray*required

The weights assigned to each response in the request, aggregated from the votes of the Ensemble LLMs.

Items
number
creatednumbermin: 0max: 4294967295*required

The Unix timestamp (in seconds) when the vector completion was created.

ensemblestring*required

The unique identifier of the Ensemble used for this vector completion.

object"vector.completion.chunk"*required
usageobjectoptional

Token and cost usage statistics for the completion.

Properties
completion_tokensnumbermin: 0max: 4294967295*required

The number of tokens generated in the completion.

prompt_tokensnumbermin: 0max: 4294967295*required

The number of tokens in the prompt.

total_tokensnumbermin: 0max: 4294967295*required

The total number of tokens used in the prompt or generated in the completion.

completion_tokens_detailsobjectoptional

Detailed breakdown of generated completion tokens.

Properties
accepted_prediction_tokensnumbermin: 0max: 4294967295optional

The number of accepted prediction tokens in the completion.

audio_tokensnumbermin: 0max: 4294967295optional

The number of generated audio tokens in the completion.

reasoning_tokensnumbermin: 0max: 4294967295optional

The number of generated reasoning tokens in the completion.

rejected_prediction_tokensnumbermin: 0max: 4294967295optional

The number of rejected prediction tokens in the completion.

prompt_tokens_detailsobjectoptional

Detailed breakdown of prompt tokens.

Properties
audio_tokensnumbermin: 0max: 4294967295optional

The number of audio tokens in the prompt.

cached_tokensnumbermin: 0max: 4294967295optional

The number of cached tokens in the prompt.

cache_write_tokensnumbermin: 0max: 4294967295optional

The number of prompt tokens written to cache.

video_tokensnumbermin: 0max: 4294967295optional

The number of video tokens in the prompt.

costnumber*required

The cost in credits incurred for this completion.

cost_detailsobjectoptional

Detailed breakdown of upstream costs incurred.

Properties
upstream_inference_costnumberoptional

The cost incurred upstream.

upstream_upstream_inference_costnumberoptional

The cost incurred by upstream's upstream.

total_costnumber*required

The total cost in credits incurred including upstream costs.

indexnumbermin: 0max: 4294967295*required

The index of the task in the sequence of tasks.

task_indexnumbermin: 0max: 4294967295*required

The index of the task amongst all mapped and non-skipped compiled tasks. Used internally.

task_patharray*required

The path of this task which may be used to navigate which nested task this is amongst the root functions tasks and sub-tasks.

Items
numbermin: 0max: 4294967295
errorobjectoptional

When present, indicates that an error occurred during the vector completion task.

Properties
codenumbermin: 0max: 4294967295*required

The status code of the error.

messageany*required

The message or details of the error.

tasks_errorsbooleanoptional

When true, indicates that one or more tasks encountered errors during execution.

outputunionoptional

The output of the function execution.

Variants
number

The scalar output of the function execution.

array

The vector output of the function execution.

Items
number
null
boolean
number
string
array
Items
JsonValue

A JSON value.

record
Values
JsonValue

A JSON value.

errorobjectoptional

When present, indicates that an error occurred during the function execution.

Properties
codenumbermin: 0max: 4294967295*required

The status code of the error.

messageany*required

The message or details of the error.

retry_tokenstringoptional

A token which may be used to retry the function execution.

creatednumbermin: 0max: 4294967295*required

The UNIX timestamp (in seconds) when the function execution chunk was created.

functionstringoptional

The unique identifier of the function being executed.

profilestringoptional

The unique identifier of the profile being used.

objectenum*required

The object type.

Variants
"scalar.function.execution.chunk"
"vector.function.execution.chunk"
usageobjectoptional

Token and cost usage statistics for the completion.

Properties
completion_tokensnumbermin: 0max: 4294967295*required

The number of tokens generated in the completion.

prompt_tokensnumbermin: 0max: 4294967295*required

The number of tokens in the prompt.

total_tokensnumbermin: 0max: 4294967295*required

The total number of tokens used in the prompt or generated in the completion.

completion_tokens_detailsobjectoptional

Detailed breakdown of generated completion tokens.

Properties
accepted_prediction_tokensnumbermin: 0max: 4294967295optional

The number of accepted prediction tokens in the completion.

audio_tokensnumbermin: 0max: 4294967295optional

The number of generated audio tokens in the completion.

reasoning_tokensnumbermin: 0max: 4294967295optional

The number of generated reasoning tokens in the completion.

rejected_prediction_tokensnumbermin: 0max: 4294967295optional

The number of rejected prediction tokens in the completion.

prompt_tokens_detailsobjectoptional

Detailed breakdown of prompt tokens.

Properties
audio_tokensnumbermin: 0max: 4294967295optional

The number of audio tokens in the prompt.

cached_tokensnumbermin: 0max: 4294967295optional

The number of cached tokens in the prompt.

cache_write_tokensnumbermin: 0max: 4294967295optional

The number of prompt tokens written to cache.

video_tokensnumbermin: 0max: 4294967295optional

The number of video tokens in the prompt.

costnumber*required

The cost in credits incurred for this completion.

cost_detailsobjectoptional

Detailed breakdown of upstream costs incurred.

Properties
upstream_inference_costnumberoptional

The cost incurred upstream.

upstream_upstream_inference_costnumberoptional

The cost incurred by upstream's upstream.

total_costnumber*required

The total cost in credits incurred including upstream costs.

Objective Artificial Intelligence, Inc.