Docs

Request Path

fownerstring*required

The owner of the GitHub repository containing the function.

frepositorystring*required

The name of the GitHub repository containing the function.

fcommitstringoptional

The commit SHA of the GitHub repository containing the function.

pownerstring*required

The owner of the GitHub repository containing the profile.

prepositorystring*required

The name of the GitHub repository containing the profile.

pcommitstringoptional

The commit SHA of the GitHub repository containing the profile.

Response Body

object
Properties
type"scalar.function"*required
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. Each will first be compiled using the parent function's input.

Items
object

A scalar function task expression.

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

A value provided as input to a function.

Variants
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
InputValueExpression
array
Items
InputValueExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input value.

Properties
$jmespathstring*required

A JMESPath expression.

object

A vector function task expression.

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

A value provided as input to a function.

Variants
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
InputValueExpression
array
Items
InputValueExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input value.

Properties
$jmespathstring*required

A JMESPath expression.

object

A vector completion task expression.

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
object
Properties
type"text"*required
textunion*required
Variants
string

The text content.

Expressionobject

An expression which evaluates to the text content.

Properties
$jmespathstring*required

A JMESPath expression.

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
object
Properties
type"text"*required
textunion*required
Variants
string

The text content.

Expressionobject

An expression which evaluates to the text content.

Properties
$jmespathstring*required

A JMESPath expression.

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
TextRichContentPartExpressionobject

A text rich content part.

Properties
type"text"*required
textunion*required

The text content.

Variants
string

The text content.

Expressionobject

An expression which evaluates to the text content.

Properties
$jmespathstring*required

A JMESPath expression.

ImageRichContentPartExpressionobject

An image rich content part.

Properties
type"image_url"*required
image_urlunion*required

The URL of the image and its optional detail level.

Variants
object

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"
Expressionobject

An expression which evaluates to the image URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

AudioRichContentPartExpressionobject

An audio rich content part.

Properties
type"input_audio"*required
input_audiounion*required

The audio data and its format.

Variants
object

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"
Expressionobject

An expression which evaluates to the audio definition.

Properties
$jmespathstring*required

A JMESPath expression.

VideoRichContentPartExpressionobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlunion*required

The video URL definition.

Variants
object
Properties
urlstring*required

URL of the video.

Expressionobject

An expression which evaluates to the video URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

FileRichContentPartExpressionobject

A file rich content part.

Properties
type"file"*required
fileunion*required

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

Variants
object

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 the file definition.

Properties
$jmespathstring*required

A JMESPath expression.

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
TextRichContentPartExpressionobject

A text rich content part.

Properties
type"text"*required
textunion*required

The text content.

Variants
string

The text content.

Expressionobject

An expression which evaluates to the text content.

Properties
$jmespathstring*required

A JMESPath expression.

ImageRichContentPartExpressionobject

An image rich content part.

Properties
type"image_url"*required
image_urlunion*required

The URL of the image and its optional detail level.

Variants
object

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"
Expressionobject

An expression which evaluates to the image URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

AudioRichContentPartExpressionobject

An audio rich content part.

Properties
type"input_audio"*required
input_audiounion*required

The audio data and its format.

Variants
object

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"
Expressionobject

An expression which evaluates to the audio definition.

Properties
$jmespathstring*required

A JMESPath expression.

VideoRichContentPartExpressionobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlunion*required

The video URL definition.

Variants
object
Properties
urlstring*required

URL of the video.

Expressionobject

An expression which evaluates to the video URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

FileRichContentPartExpressionobject

A file rich content part.

Properties
type"file"*required
fileunion*required

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

Variants
object

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 the file definition.

Properties
$jmespathstring*required

A JMESPath expression.

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
TextRichContentPartExpressionobject

A text rich content part.

Properties
type"text"*required
textunion*required

The text content.

Variants
string

The text content.

Expressionobject

An expression which evaluates to the text content.

Properties
$jmespathstring*required

A JMESPath expression.

ImageRichContentPartExpressionobject

An image rich content part.

Properties
type"image_url"*required
image_urlunion*required

The URL of the image and its optional detail level.

Variants
object

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"
Expressionobject

An expression which evaluates to the image URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

AudioRichContentPartExpressionobject

An audio rich content part.

Properties
type"input_audio"*required
input_audiounion*required

The audio data and its format.

Variants
object

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"
Expressionobject

An expression which evaluates to the audio definition.

Properties
$jmespathstring*required

A JMESPath expression.

VideoRichContentPartExpressionobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlunion*required

The video URL definition.

Variants
object
Properties
urlstring*required

URL of the video.

Expressionobject

An expression which evaluates to the video URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

FileRichContentPartExpressionobject

A file rich content part.

Properties
type"file"*required
fileunion*required

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

Variants
object

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 the file definition.

Properties
$jmespathstring*required

A JMESPath expression.

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
JsonValueNullnull

Null

JsonValueBooleanboolean

Boolean

JsonValueNumbernumber

Number

JsonValueStringstring

String

JsonValueExpressionArrayarray

Array (values may be expressions)

Items
JsonValueExpression

A JSON value.

JsonValueExpressionObjectrecord

Object (values may be expressions)

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.

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
ObjectInputSchemaobject

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
ArrayInputSchemaobject

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
StringInputSchemaobject

A string input schema.

Properties
type"string"*required
descriptionstringoptional

The description of the string input.

enumarrayoptional

The enumeration of allowed string values.

Items
string
NumberInputSchemaobject

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.

IntegerInputSchemaobject

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.

BooleanInputSchemaobject

A boolean input schema.

Properties
type"boolean"*required
descriptionstringoptional

The description of the boolean input.

ImageInputSchemaobject

An image input schema.

Properties
type"image"*required
descriptionstringoptional

The description of the image input.

AudioInputSchemaobject

An audio input schema.

Properties
type"audio"*required
descriptionstringoptional

The description of the audio input.

VideoInputSchemaobject

A video input schema.

Properties
type"video"*required
descriptionstringoptional

The description of the video input.

FileInputSchemaobject

A file input schema.

Properties
type"file"*required
descriptionstringoptional

The description of the file input.

AnyOfInputSchemaobject

A union of schemas - input must match at least one.

Properties
anyOfarray*required

The possible schemas that the input can match.

Items
InputSchema
fownerstring*required

The owner of the GitHub repository containing the function.

frepositorystring*required

The name of the GitHub repository containing the function.

fcommitstring*required

The commit SHA of the GitHub repository containing the function.

pownerstring*required

The owner of the GitHub repository containing the profile.

prepositorystring*required

The name of the GitHub repository containing the profile.

pcommitstring*required

The commit SHA of the GitHub repository containing the profile.

profileobject*required

A function profile fetched from GitHub. "profile.json"

Properties
tasksarray*required

The list of task profiles.

Items
RemoteFunctionTaskProfileobject

The identifiers for a function profile hosted in a GitHub repository.

Properties
ownerstring*required

The owner of the GitHub repository containing the profile.

repositorystring*required

The name of the GitHub repository containing the profile.

commitstring*required

The commit SHA of the GitHub repository containing the profile.

InlineFunctionTaskProfileobject

A function profile defined inline.

Properties
tasksarray*required

The list of task profiles.

Items
TaskProfile
object

A vector completion profile for a vector completion task containing an Ensemble and array of weights.

Properties
ensembleunion*required

The Ensemble to use for this completion. May be a unique ID or an inline definition.

Variants
EnsembleIdstring

The unique identifier for the Ensemble.

EnsembleBaseobject

An ensemble of LLMs.

Properties
llmsarray*required

The list of LLMs that make up the ensemble.

Items
EnsembleLlmBaseWithFallbacksAndCountobject

An LLM to be used within an Ensemble, including optional fallbacks and count.

Properties
modelstring*required

The full ID of the LLM to use.

output_modeenum*required

For Vector Completions only, specifies the LLM's voting output mode. For "instruction", the assistant is instructed to output a key. For "json_schema", the assistant is constrained to output a valid key using a JSON schema. For "tool_call", the assistant is instructed to output a tool call to select the key.

Variants
"instruction"
"json_schema"
"tool_call"
synthetic_reasoningbooleanoptional

For Vector Completions only, whether to use synthetic reasoning prior to voting. Works for any LLM, even those that do not have native reasoning capabilities.

top_logprobsnumbermin: 0max: 20optional

For Vector Completions only, whether to use logprobs to make the vote probabilistic. This means that the LLM can vote for multiple keys based on their logprobabilities. Allows LLMs to express native uncertainty when voting.

prefix_messagesarrayoptional

A list of messages exchanged in a chat conversation. These will be prepended to every prompt sent to this LLM. Useful for setting context or influencing behavior.

Items
DeveloperMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

SystemMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

UserMessageobject

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.

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.

namestringoptional

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

ToolMessageobject

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.

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.

tool_call_idstring*required

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

AssistantMessageobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
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.

namestringoptional

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

refusalstringoptional

The refusal message by the assistant.

tool_callsarrayoptional

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionobject

A function tool call made by the assistant.

Properties
type"function"*required
idstring*required

The unique identifier for the tool call.

functionobject*required

The name and arguments of the function called.

Properties
namestring*required

The name of the function called.

argumentsstring*required

The arguments passed to the function.

reasoningstringoptional

The reasoning provided by the assistant.

suffix_messagesarrayoptional

A list of messages exchanged in a chat conversation. These will be appended to every prompt sent to this LLM. Useful for setting context or influencing behavior.

Items
DeveloperMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

SystemMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

UserMessageobject

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.

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.

namestringoptional

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

ToolMessageobject

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.

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.

tool_call_idstring*required

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

AssistantMessageobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
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.

namestringoptional

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

refusalstringoptional

The refusal message by the assistant.

tool_callsarrayoptional

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionobject

A function tool call made by the assistant.

Properties
type"function"*required
idstring*required

The unique identifier for the tool call.

functionobject*required

The name and arguments of the function called.

Properties
namestring*required

The name of the function called.

argumentsstring*required

The arguments passed to the function.

reasoningstringoptional

The reasoning provided by the assistant.

frequency_penaltynumbermin: -2max: 2optional

This setting aims to control the repetition of tokens based on how often they appear in the input. It tries to use less frequently those tokens that appear more in the input, proportional to how frequently they occur. Token penalty scales with the number of occurrences. Negative values will encourage token reuse.

logit_biasrecordoptional

Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

Values
numbermin: -100max: 100
max_completion_tokensnumbermin: 0max: 2147483647optional

An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

presence_penaltynumbermin: -2max: 2optional

This setting aims to control the presence of tokens in the output. It tries to encourage the model to use tokens that are less present in the input, proportional to their presence in the input. Token presence scales with the number of occurrences. Negative values will encourage more diverse token usage.

stopunionoptional

The assistant will stop when any of the provided strings are generated.

Variants
StopStringstring

Generation will stop when this string is generated.

StopStringsarray

Generation will stop when any of these strings are generated.

Items
StopStringstring
temperaturenumbermin: 0max: 2optional

This setting influences the variety in the model’s responses. Lower values lead to more predictable and typical responses, while higher values encourage more diverse and less common responses. At 0, the model always gives the same response for a given input.

top_pnumbermin: 0max: 1optional

This setting limits the model’s choices to a percentage of likely tokens: only the top tokens whose probabilities add up to P. A lower value makes the model’s responses more predictable, while the default setting allows for a full range of token choices. Think of it like a dynamic Top-K.

max_tokensnumbermin: 0max: 2147483647optional

This sets the upper limit for the number of tokens the model can generate in response. It won’t produce more than this limit. The maximum value is the context length minus the prompt length.

min_pnumbermin: 0max: 1optional

Represents the minimum probability for a token to be considered, relative to the probability of the most likely token. (The value changes depending on the confidence level of the most probable token.) If your Min-P is set to 0.1, that means it will only allow for tokens that are at least 1/10th as probable as the best possible option.

providerobjectoptional

Options for selecting the upstream provider of this model.

Properties
allow_fallbacksbooleanoptional

Whether to allow fallback providers if the preferred provider is unavailable.

require_parametersbooleanoptional

Whether to require that the provider supports all specified parameters.

orderarrayoptional

An ordered list of provider names to use when selecting a provider for this model.

Items
ProviderNamestring
onlyarrayoptional

A list of provider names to restrict selection to when selecting a provider for this model.

Items
ProviderNamestring
ignorearrayoptional

A list of provider names to ignore when selecting a provider for this model.

Items
ProviderNamestring
quantizationsarrayoptional

Specifies the quantizations to allow when selecting providers for this model.

Items
"int4"
"int8"
"fp4"
"fp6"
"fp8"
"fp16"
"bf16"
"fp32"
"unknown"
reasoningobjectoptional

Options for controlling reasoning behavior of the model.

Properties
enabledbooleanoptional

Enables or disables reasoning for supported models.

max_tokensnumbermin: 0max: 2147483647optional

The maximum number of tokens to use for reasoning in a response.

effortenumoptional

Constrains effort on reasoning for supported reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

Variants
"none"
"minimal"
"low"
"medium"
"high"
"xhigh"
summary_verbosityenumoptional

Controls the verbosity of the reasoning summary for supported reasoning models.

Variants
"auto"
"concise"
"detailed"
repetition_penaltynumbermin: 0max: 2optional

Helps to reduce the repetition of tokens from the input. A higher value makes the model less likely to repeat tokens, but too high a value can make the output less coherent (often with run-on sentences that lack small words). Token penalty scales based on original token’s probability.

top_anumbermin: 0max: 1optional

Consider only the top tokens with “sufficiently high” probabilities based on the probability of the most likely token. Think of it like a dynamic Top-P. A lower Top-A value focuses the choices based on the highest probability token but with a narrower scope. A higher Top-A value does not necessarily affect the creativity of the output, but rather refines the filtering process based on the maximum probability.

top_knumbermin: 0max: 2147483647optional

This limits the model’s choice of tokens at each step, making it choose from a smaller set. A value of 1 means the model will always pick the most likely next token, leading to predictable results. By default this setting is disabled, making the model to consider all choices.

verbosityenumoptional

Controls the verbosity and length of the model response. Lower values produce more concise responses, while higher values produce more detailed and comprehensive responses.

Variants
"low"
"medium"
"high"
countnumbermin: 1max: 4294967295optional

A count greater than one effectively means that there are multiple instances of this LLM in an ensemble.

fallbacksarrayoptional

A list of fallback LLMs to use if the primary LLM fails.

Items
EnsembleLlmBaseobject

An LLM to be used within an Ensemble or standalone with Chat Completions.

Properties
modelstring*required

The full ID of the LLM to use.

output_modeenum*required

For Vector Completions only, specifies the LLM's voting output mode. For "instruction", the assistant is instructed to output a key. For "json_schema", the assistant is constrained to output a valid key using a JSON schema. For "tool_call", the assistant is instructed to output a tool call to select the key.

Variants
"instruction"
"json_schema"
"tool_call"
synthetic_reasoningbooleanoptional

For Vector Completions only, whether to use synthetic reasoning prior to voting. Works for any LLM, even those that do not have native reasoning capabilities.

top_logprobsnumbermin: 0max: 20optional

For Vector Completions only, whether to use logprobs to make the vote probabilistic. This means that the LLM can vote for multiple keys based on their logprobabilities. Allows LLMs to express native uncertainty when voting.

prefix_messagesarrayoptional

A list of messages exchanged in a chat conversation. These will be prepended to every prompt sent to this LLM. Useful for setting context or influencing behavior.

Items
DeveloperMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

SystemMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

UserMessageobject

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.

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.

namestringoptional

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

ToolMessageobject

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.

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.

tool_call_idstring*required

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

AssistantMessageobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
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.

namestringoptional

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

refusalstringoptional

The refusal message by the assistant.

tool_callsarrayoptional

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionobject

A function tool call made by the assistant.

Properties
type"function"*required
idstring*required

The unique identifier for the tool call.

functionobject*required

The name and arguments of the function called.

Properties
namestring*required

The name of the function called.

argumentsstring*required

The arguments passed to the function.

reasoningstringoptional

The reasoning provided by the assistant.

suffix_messagesarrayoptional

A list of messages exchanged in a chat conversation. These will be appended to every prompt sent to this LLM. Useful for setting context or influencing behavior.

Items
DeveloperMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

SystemMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

UserMessageobject

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.

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.

namestringoptional

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

ToolMessageobject

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.

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.

tool_call_idstring*required

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

AssistantMessageobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
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.

namestringoptional

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

refusalstringoptional

The refusal message by the assistant.

tool_callsarrayoptional

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionobject

A function tool call made by the assistant.

Properties
type"function"*required
idstring*required

The unique identifier for the tool call.

functionobject*required

The name and arguments of the function called.

Properties
namestring*required

The name of the function called.

argumentsstring*required

The arguments passed to the function.

reasoningstringoptional

The reasoning provided by the assistant.

frequency_penaltynumbermin: -2max: 2optional

This setting aims to control the repetition of tokens based on how often they appear in the input. It tries to use less frequently those tokens that appear more in the input, proportional to how frequently they occur. Token penalty scales with the number of occurrences. Negative values will encourage token reuse.

logit_biasrecordoptional

Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

Values
numbermin: -100max: 100
max_completion_tokensnumbermin: 0max: 2147483647optional

An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

presence_penaltynumbermin: -2max: 2optional

This setting aims to control the presence of tokens in the output. It tries to encourage the model to use tokens that are less present in the input, proportional to their presence in the input. Token presence scales with the number of occurrences. Negative values will encourage more diverse token usage.

stopunionoptional

The assistant will stop when any of the provided strings are generated.

Variants
StopStringstring

Generation will stop when this string is generated.

StopStringsarray

Generation will stop when any of these strings are generated.

Items
StopStringstring
temperaturenumbermin: 0max: 2optional

This setting influences the variety in the model’s responses. Lower values lead to more predictable and typical responses, while higher values encourage more diverse and less common responses. At 0, the model always gives the same response for a given input.

top_pnumbermin: 0max: 1optional

This setting limits the model’s choices to a percentage of likely tokens: only the top tokens whose probabilities add up to P. A lower value makes the model’s responses more predictable, while the default setting allows for a full range of token choices. Think of it like a dynamic Top-K.

max_tokensnumbermin: 0max: 2147483647optional

This sets the upper limit for the number of tokens the model can generate in response. It won’t produce more than this limit. The maximum value is the context length minus the prompt length.

min_pnumbermin: 0max: 1optional

Represents the minimum probability for a token to be considered, relative to the probability of the most likely token. (The value changes depending on the confidence level of the most probable token.) If your Min-P is set to 0.1, that means it will only allow for tokens that are at least 1/10th as probable as the best possible option.

providerobjectoptional

Options for selecting the upstream provider of this model.

Properties
allow_fallbacksbooleanoptional

Whether to allow fallback providers if the preferred provider is unavailable.

require_parametersbooleanoptional

Whether to require that the provider supports all specified parameters.

orderarrayoptional

An ordered list of provider names to use when selecting a provider for this model.

Items
ProviderNamestring
onlyarrayoptional

A list of provider names to restrict selection to when selecting a provider for this model.

Items
ProviderNamestring
ignorearrayoptional

A list of provider names to ignore when selecting a provider for this model.

Items
ProviderNamestring
quantizationsarrayoptional

Specifies the quantizations to allow when selecting providers for this model.

Items
"int4"
"int8"
"fp4"
"fp6"
"fp8"
"fp16"
"bf16"
"fp32"
"unknown"
reasoningobjectoptional

Options for controlling reasoning behavior of the model.

Properties
enabledbooleanoptional

Enables or disables reasoning for supported models.

max_tokensnumbermin: 0max: 2147483647optional

The maximum number of tokens to use for reasoning in a response.

effortenumoptional

Constrains effort on reasoning for supported reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

Variants
"none"
"minimal"
"low"
"medium"
"high"
"xhigh"
summary_verbosityenumoptional

Controls the verbosity of the reasoning summary for supported reasoning models.

Variants
"auto"
"concise"
"detailed"
repetition_penaltynumbermin: 0max: 2optional

Helps to reduce the repetition of tokens from the input. A higher value makes the model less likely to repeat tokens, but too high a value can make the output less coherent (often with run-on sentences that lack small words). Token penalty scales based on original token’s probability.

top_anumbermin: 0max: 1optional

Consider only the top tokens with “sufficiently high” probabilities based on the probability of the most likely token. Think of it like a dynamic Top-P. A lower Top-A value focuses the choices based on the highest probability token but with a narrower scope. A higher Top-A value does not necessarily affect the creativity of the output, but rather refines the filtering process based on the maximum probability.

top_knumbermin: 0max: 2147483647optional

This limits the model’s choice of tokens at each step, making it choose from a smaller set. A value of 1 means the model will always pick the most likely next token, leading to predictable results. By default this setting is disabled, making the model to consider all choices.

verbosityenumoptional

Controls the verbosity and length of the model response. Lower values produce more concise responses, while higher values produce more detailed and comprehensive responses.

Variants
"low"
"medium"
"high"
profilearray*required

The profile to use for the completion. Must be of the same length as the Ensemble's llms field, ignoring count.

Items
number
descriptionstring*required

The description of the profile.

changelogstringoptional

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

object
Properties
type"vector.function"*required
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. Each will first be compiled using the parent function's input.

Items
object

A scalar function task expression.

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

A value provided as input to a function.

Variants
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
InputValueExpression
array
Items
InputValueExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input value.

Properties
$jmespathstring*required

A JMESPath expression.

object

A vector function task expression.

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

A value provided as input to a function.

Variants
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
InputValueExpression
array
Items
InputValueExpression
string
number
boolean
Expressionobject

An expression which evaluates to an input value.

Properties
$jmespathstring*required

A JMESPath expression.

object

A vector completion task expression.

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
object
Properties
type"text"*required
textunion*required
Variants
string

The text content.

Expressionobject

An expression which evaluates to the text content.

Properties
$jmespathstring*required

A JMESPath expression.

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
object
Properties
type"text"*required
textunion*required
Variants
string

The text content.

Expressionobject

An expression which evaluates to the text content.

Properties
$jmespathstring*required

A JMESPath expression.

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
TextRichContentPartExpressionobject

A text rich content part.

Properties
type"text"*required
textunion*required

The text content.

Variants
string

The text content.

Expressionobject

An expression which evaluates to the text content.

Properties
$jmespathstring*required

A JMESPath expression.

ImageRichContentPartExpressionobject

An image rich content part.

Properties
type"image_url"*required
image_urlunion*required

The URL of the image and its optional detail level.

Variants
object

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"
Expressionobject

An expression which evaluates to the image URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

AudioRichContentPartExpressionobject

An audio rich content part.

Properties
type"input_audio"*required
input_audiounion*required

The audio data and its format.

Variants
object

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"
Expressionobject

An expression which evaluates to the audio definition.

Properties
$jmespathstring*required

A JMESPath expression.

VideoRichContentPartExpressionobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlunion*required

The video URL definition.

Variants
object
Properties
urlstring*required

URL of the video.

Expressionobject

An expression which evaluates to the video URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

FileRichContentPartExpressionobject

A file rich content part.

Properties
type"file"*required
fileunion*required

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

Variants
object

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 the file definition.

Properties
$jmespathstring*required

A JMESPath expression.

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
TextRichContentPartExpressionobject

A text rich content part.

Properties
type"text"*required
textunion*required

The text content.

Variants
string

The text content.

Expressionobject

An expression which evaluates to the text content.

Properties
$jmespathstring*required

A JMESPath expression.

ImageRichContentPartExpressionobject

An image rich content part.

Properties
type"image_url"*required
image_urlunion*required

The URL of the image and its optional detail level.

Variants
object

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"
Expressionobject

An expression which evaluates to the image URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

AudioRichContentPartExpressionobject

An audio rich content part.

Properties
type"input_audio"*required
input_audiounion*required

The audio data and its format.

Variants
object

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"
Expressionobject

An expression which evaluates to the audio definition.

Properties
$jmespathstring*required

A JMESPath expression.

VideoRichContentPartExpressionobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlunion*required

The video URL definition.

Variants
object
Properties
urlstring*required

URL of the video.

Expressionobject

An expression which evaluates to the video URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

FileRichContentPartExpressionobject

A file rich content part.

Properties
type"file"*required
fileunion*required

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

Variants
object

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 the file definition.

Properties
$jmespathstring*required

A JMESPath expression.

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
TextRichContentPartExpressionobject

A text rich content part.

Properties
type"text"*required
textunion*required

The text content.

Variants
string

The text content.

Expressionobject

An expression which evaluates to the text content.

Properties
$jmespathstring*required

A JMESPath expression.

ImageRichContentPartExpressionobject

An image rich content part.

Properties
type"image_url"*required
image_urlunion*required

The URL of the image and its optional detail level.

Variants
object

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"
Expressionobject

An expression which evaluates to the image URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

AudioRichContentPartExpressionobject

An audio rich content part.

Properties
type"input_audio"*required
input_audiounion*required

The audio data and its format.

Variants
object

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"
Expressionobject

An expression which evaluates to the audio definition.

Properties
$jmespathstring*required

A JMESPath expression.

VideoRichContentPartExpressionobject

A video rich content part.

Properties
typeenum*required
Variants
"video_url"
"input_video"
video_urlunion*required

The video URL definition.

Variants
object
Properties
urlstring*required

URL of the video.

Expressionobject

An expression which evaluates to the video URL definition.

Properties
$jmespathstring*required

A JMESPath expression.

FileRichContentPartExpressionobject

A file rich content part.

Properties
type"file"*required
fileunion*required

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

Variants
object

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 the file definition.

Properties
$jmespathstring*required

A JMESPath expression.

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
JsonValueNullnull

Null

JsonValueBooleanboolean

Boolean

JsonValueNumbernumber

Number

JsonValueStringstring

String

JsonValueExpressionArrayarray

Array (values may be expressions)

Items
JsonValueExpression

A JSON value.

JsonValueExpressionObjectrecord

Object (values may be expressions)

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 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.

input_splitobject*required

An expression transforming input into an array of inputs. When the Function is executed with any input from the array, the output_length should be 1.

Properties
$jmespathstring*required

A JMESPath expression.

input_mergeobject*required

An expression transforming an array of inputs (computed by input_split) into a single Input object for the Function.

Properties
$jmespathstring*required

A JMESPath expression.

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
ObjectInputSchemaobject

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
ArrayInputSchemaobject

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
StringInputSchemaobject

A string input schema.

Properties
type"string"*required
descriptionstringoptional

The description of the string input.

enumarrayoptional

The enumeration of allowed string values.

Items
string
NumberInputSchemaobject

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.

IntegerInputSchemaobject

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.

BooleanInputSchemaobject

A boolean input schema.

Properties
type"boolean"*required
descriptionstringoptional

The description of the boolean input.

ImageInputSchemaobject

An image input schema.

Properties
type"image"*required
descriptionstringoptional

The description of the image input.

AudioInputSchemaobject

An audio input schema.

Properties
type"audio"*required
descriptionstringoptional

The description of the audio input.

VideoInputSchemaobject

A video input schema.

Properties
type"video"*required
descriptionstringoptional

The description of the video input.

FileInputSchemaobject

A file input schema.

Properties
type"file"*required
descriptionstringoptional

The description of the file input.

AnyOfInputSchemaobject

A union of schemas - input must match at least one.

Properties
anyOfarray*required

The possible schemas that the input can match.

Items
InputSchema
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.

fownerstring*required

The owner of the GitHub repository containing the function.

frepositorystring*required

The name of the GitHub repository containing the function.

fcommitstring*required

The commit SHA of the GitHub repository containing the function.

pownerstring*required

The owner of the GitHub repository containing the profile.

prepositorystring*required

The name of the GitHub repository containing the profile.

pcommitstring*required

The commit SHA of the GitHub repository containing the profile.

profileobject*required

A function profile fetched from GitHub. "profile.json"

Properties
tasksarray*required

The list of task profiles.

Items
RemoteFunctionTaskProfileobject

The identifiers for a function profile hosted in a GitHub repository.

Properties
ownerstring*required

The owner of the GitHub repository containing the profile.

repositorystring*required

The name of the GitHub repository containing the profile.

commitstring*required

The commit SHA of the GitHub repository containing the profile.

InlineFunctionTaskProfileobject

A function profile defined inline.

Properties
tasksarray*required

The list of task profiles.

Items
TaskProfile
object

A vector completion profile for a vector completion task containing an Ensemble and array of weights.

Properties
ensembleunion*required

The Ensemble to use for this completion. May be a unique ID or an inline definition.

Variants
EnsembleIdstring

The unique identifier for the Ensemble.

EnsembleBaseobject

An ensemble of LLMs.

Properties
llmsarray*required

The list of LLMs that make up the ensemble.

Items
EnsembleLlmBaseWithFallbacksAndCountobject

An LLM to be used within an Ensemble, including optional fallbacks and count.

Properties
modelstring*required

The full ID of the LLM to use.

output_modeenum*required

For Vector Completions only, specifies the LLM's voting output mode. For "instruction", the assistant is instructed to output a key. For "json_schema", the assistant is constrained to output a valid key using a JSON schema. For "tool_call", the assistant is instructed to output a tool call to select the key.

Variants
"instruction"
"json_schema"
"tool_call"
synthetic_reasoningbooleanoptional

For Vector Completions only, whether to use synthetic reasoning prior to voting. Works for any LLM, even those that do not have native reasoning capabilities.

top_logprobsnumbermin: 0max: 20optional

For Vector Completions only, whether to use logprobs to make the vote probabilistic. This means that the LLM can vote for multiple keys based on their logprobabilities. Allows LLMs to express native uncertainty when voting.

prefix_messagesarrayoptional

A list of messages exchanged in a chat conversation. These will be prepended to every prompt sent to this LLM. Useful for setting context or influencing behavior.

Items
DeveloperMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

SystemMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

UserMessageobject

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.

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.

namestringoptional

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

ToolMessageobject

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.

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.

tool_call_idstring*required

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

AssistantMessageobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
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.

namestringoptional

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

refusalstringoptional

The refusal message by the assistant.

tool_callsarrayoptional

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionobject

A function tool call made by the assistant.

Properties
type"function"*required
idstring*required

The unique identifier for the tool call.

functionobject*required

The name and arguments of the function called.

Properties
namestring*required

The name of the function called.

argumentsstring*required

The arguments passed to the function.

reasoningstringoptional

The reasoning provided by the assistant.

suffix_messagesarrayoptional

A list of messages exchanged in a chat conversation. These will be appended to every prompt sent to this LLM. Useful for setting context or influencing behavior.

Items
DeveloperMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

SystemMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

UserMessageobject

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.

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.

namestringoptional

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

ToolMessageobject

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.

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.

tool_call_idstring*required

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

AssistantMessageobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
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.

namestringoptional

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

refusalstringoptional

The refusal message by the assistant.

tool_callsarrayoptional

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionobject

A function tool call made by the assistant.

Properties
type"function"*required
idstring*required

The unique identifier for the tool call.

functionobject*required

The name and arguments of the function called.

Properties
namestring*required

The name of the function called.

argumentsstring*required

The arguments passed to the function.

reasoningstringoptional

The reasoning provided by the assistant.

frequency_penaltynumbermin: -2max: 2optional

This setting aims to control the repetition of tokens based on how often they appear in the input. It tries to use less frequently those tokens that appear more in the input, proportional to how frequently they occur. Token penalty scales with the number of occurrences. Negative values will encourage token reuse.

logit_biasrecordoptional

Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

Values
numbermin: -100max: 100
max_completion_tokensnumbermin: 0max: 2147483647optional

An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

presence_penaltynumbermin: -2max: 2optional

This setting aims to control the presence of tokens in the output. It tries to encourage the model to use tokens that are less present in the input, proportional to their presence in the input. Token presence scales with the number of occurrences. Negative values will encourage more diverse token usage.

stopunionoptional

The assistant will stop when any of the provided strings are generated.

Variants
StopStringstring

Generation will stop when this string is generated.

StopStringsarray

Generation will stop when any of these strings are generated.

Items
StopStringstring
temperaturenumbermin: 0max: 2optional

This setting influences the variety in the model’s responses. Lower values lead to more predictable and typical responses, while higher values encourage more diverse and less common responses. At 0, the model always gives the same response for a given input.

top_pnumbermin: 0max: 1optional

This setting limits the model’s choices to a percentage of likely tokens: only the top tokens whose probabilities add up to P. A lower value makes the model’s responses more predictable, while the default setting allows for a full range of token choices. Think of it like a dynamic Top-K.

max_tokensnumbermin: 0max: 2147483647optional

This sets the upper limit for the number of tokens the model can generate in response. It won’t produce more than this limit. The maximum value is the context length minus the prompt length.

min_pnumbermin: 0max: 1optional

Represents the minimum probability for a token to be considered, relative to the probability of the most likely token. (The value changes depending on the confidence level of the most probable token.) If your Min-P is set to 0.1, that means it will only allow for tokens that are at least 1/10th as probable as the best possible option.

providerobjectoptional

Options for selecting the upstream provider of this model.

Properties
allow_fallbacksbooleanoptional

Whether to allow fallback providers if the preferred provider is unavailable.

require_parametersbooleanoptional

Whether to require that the provider supports all specified parameters.

orderarrayoptional

An ordered list of provider names to use when selecting a provider for this model.

Items
ProviderNamestring
onlyarrayoptional

A list of provider names to restrict selection to when selecting a provider for this model.

Items
ProviderNamestring
ignorearrayoptional

A list of provider names to ignore when selecting a provider for this model.

Items
ProviderNamestring
quantizationsarrayoptional

Specifies the quantizations to allow when selecting providers for this model.

Items
"int4"
"int8"
"fp4"
"fp6"
"fp8"
"fp16"
"bf16"
"fp32"
"unknown"
reasoningobjectoptional

Options for controlling reasoning behavior of the model.

Properties
enabledbooleanoptional

Enables or disables reasoning for supported models.

max_tokensnumbermin: 0max: 2147483647optional

The maximum number of tokens to use for reasoning in a response.

effortenumoptional

Constrains effort on reasoning for supported reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

Variants
"none"
"minimal"
"low"
"medium"
"high"
"xhigh"
summary_verbosityenumoptional

Controls the verbosity of the reasoning summary for supported reasoning models.

Variants
"auto"
"concise"
"detailed"
repetition_penaltynumbermin: 0max: 2optional

Helps to reduce the repetition of tokens from the input. A higher value makes the model less likely to repeat tokens, but too high a value can make the output less coherent (often with run-on sentences that lack small words). Token penalty scales based on original token’s probability.

top_anumbermin: 0max: 1optional

Consider only the top tokens with “sufficiently high” probabilities based on the probability of the most likely token. Think of it like a dynamic Top-P. A lower Top-A value focuses the choices based on the highest probability token but with a narrower scope. A higher Top-A value does not necessarily affect the creativity of the output, but rather refines the filtering process based on the maximum probability.

top_knumbermin: 0max: 2147483647optional

This limits the model’s choice of tokens at each step, making it choose from a smaller set. A value of 1 means the model will always pick the most likely next token, leading to predictable results. By default this setting is disabled, making the model to consider all choices.

verbosityenumoptional

Controls the verbosity and length of the model response. Lower values produce more concise responses, while higher values produce more detailed and comprehensive responses.

Variants
"low"
"medium"
"high"
countnumbermin: 1max: 4294967295optional

A count greater than one effectively means that there are multiple instances of this LLM in an ensemble.

fallbacksarrayoptional

A list of fallback LLMs to use if the primary LLM fails.

Items
EnsembleLlmBaseobject

An LLM to be used within an Ensemble or standalone with Chat Completions.

Properties
modelstring*required

The full ID of the LLM to use.

output_modeenum*required

For Vector Completions only, specifies the LLM's voting output mode. For "instruction", the assistant is instructed to output a key. For "json_schema", the assistant is constrained to output a valid key using a JSON schema. For "tool_call", the assistant is instructed to output a tool call to select the key.

Variants
"instruction"
"json_schema"
"tool_call"
synthetic_reasoningbooleanoptional

For Vector Completions only, whether to use synthetic reasoning prior to voting. Works for any LLM, even those that do not have native reasoning capabilities.

top_logprobsnumbermin: 0max: 20optional

For Vector Completions only, whether to use logprobs to make the vote probabilistic. This means that the LLM can vote for multiple keys based on their logprobabilities. Allows LLMs to express native uncertainty when voting.

prefix_messagesarrayoptional

A list of messages exchanged in a chat conversation. These will be prepended to every prompt sent to this LLM. Useful for setting context or influencing behavior.

Items
DeveloperMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

SystemMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

UserMessageobject

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.

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.

namestringoptional

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

ToolMessageobject

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.

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.

tool_call_idstring*required

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

AssistantMessageobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
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.

namestringoptional

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

refusalstringoptional

The refusal message by the assistant.

tool_callsarrayoptional

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionobject

A function tool call made by the assistant.

Properties
type"function"*required
idstring*required

The unique identifier for the tool call.

functionobject*required

The name and arguments of the function called.

Properties
namestring*required

The name of the function called.

argumentsstring*required

The arguments passed to the function.

reasoningstringoptional

The reasoning provided by the assistant.

suffix_messagesarrayoptional

A list of messages exchanged in a chat conversation. These will be appended to every prompt sent to this LLM. Useful for setting context or influencing behavior.

Items
DeveloperMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

SystemMessageobject

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.

SimpleContentPartsarray

An array of simple content parts.

Items
SimpleContentPartobject

A simple content part.

Properties
type"text"*required
textstring*required

The text content.

namestringoptional

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

UserMessageobject

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.

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.

namestringoptional

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

ToolMessageobject

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.

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.

tool_call_idstring*required

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

AssistantMessageobject

Messages sent by the model in response to user messages.

Properties
role"assistant"*required
contentunionoptional

Rich content.

Variants
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.

namestringoptional

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

refusalstringoptional

The refusal message by the assistant.

tool_callsarrayoptional

Tool calls made by the assistant.

Items
AssistantMessageToolCallFunctionobject

A function tool call made by the assistant.

Properties
type"function"*required
idstring*required

The unique identifier for the tool call.

functionobject*required

The name and arguments of the function called.

Properties
namestring*required

The name of the function called.

argumentsstring*required

The arguments passed to the function.

reasoningstringoptional

The reasoning provided by the assistant.

frequency_penaltynumbermin: -2max: 2optional

This setting aims to control the repetition of tokens based on how often they appear in the input. It tries to use less frequently those tokens that appear more in the input, proportional to how frequently they occur. Token penalty scales with the number of occurrences. Negative values will encourage token reuse.

logit_biasrecordoptional

Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

Values
numbermin: -100max: 100
max_completion_tokensnumbermin: 0max: 2147483647optional

An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

presence_penaltynumbermin: -2max: 2optional

This setting aims to control the presence of tokens in the output. It tries to encourage the model to use tokens that are less present in the input, proportional to their presence in the input. Token presence scales with the number of occurrences. Negative values will encourage more diverse token usage.

stopunionoptional

The assistant will stop when any of the provided strings are generated.

Variants
StopStringstring

Generation will stop when this string is generated.

StopStringsarray

Generation will stop when any of these strings are generated.

Items
StopStringstring
temperaturenumbermin: 0max: 2optional

This setting influences the variety in the model’s responses. Lower values lead to more predictable and typical responses, while higher values encourage more diverse and less common responses. At 0, the model always gives the same response for a given input.

top_pnumbermin: 0max: 1optional

This setting limits the model’s choices to a percentage of likely tokens: only the top tokens whose probabilities add up to P. A lower value makes the model’s responses more predictable, while the default setting allows for a full range of token choices. Think of it like a dynamic Top-K.

max_tokensnumbermin: 0max: 2147483647optional

This sets the upper limit for the number of tokens the model can generate in response. It won’t produce more than this limit. The maximum value is the context length minus the prompt length.

min_pnumbermin: 0max: 1optional

Represents the minimum probability for a token to be considered, relative to the probability of the most likely token. (The value changes depending on the confidence level of the most probable token.) If your Min-P is set to 0.1, that means it will only allow for tokens that are at least 1/10th as probable as the best possible option.

providerobjectoptional

Options for selecting the upstream provider of this model.

Properties
allow_fallbacksbooleanoptional

Whether to allow fallback providers if the preferred provider is unavailable.

require_parametersbooleanoptional

Whether to require that the provider supports all specified parameters.

orderarrayoptional

An ordered list of provider names to use when selecting a provider for this model.

Items
ProviderNamestring
onlyarrayoptional

A list of provider names to restrict selection to when selecting a provider for this model.

Items
ProviderNamestring
ignorearrayoptional

A list of provider names to ignore when selecting a provider for this model.

Items
ProviderNamestring
quantizationsarrayoptional

Specifies the quantizations to allow when selecting providers for this model.

Items
"int4"
"int8"
"fp4"
"fp6"
"fp8"
"fp16"
"bf16"
"fp32"
"unknown"
reasoningobjectoptional

Options for controlling reasoning behavior of the model.

Properties
enabledbooleanoptional

Enables or disables reasoning for supported models.

max_tokensnumbermin: 0max: 2147483647optional

The maximum number of tokens to use for reasoning in a response.

effortenumoptional

Constrains effort on reasoning for supported reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

Variants
"none"
"minimal"
"low"
"medium"
"high"
"xhigh"
summary_verbosityenumoptional

Controls the verbosity of the reasoning summary for supported reasoning models.

Variants
"auto"
"concise"
"detailed"
repetition_penaltynumbermin: 0max: 2optional

Helps to reduce the repetition of tokens from the input. A higher value makes the model less likely to repeat tokens, but too high a value can make the output less coherent (often with run-on sentences that lack small words). Token penalty scales based on original token’s probability.

top_anumbermin: 0max: 1optional

Consider only the top tokens with “sufficiently high” probabilities based on the probability of the most likely token. Think of it like a dynamic Top-P. A lower Top-A value focuses the choices based on the highest probability token but with a narrower scope. A higher Top-A value does not necessarily affect the creativity of the output, but rather refines the filtering process based on the maximum probability.

top_knumbermin: 0max: 2147483647optional

This limits the model’s choice of tokens at each step, making it choose from a smaller set. A value of 1 means the model will always pick the most likely next token, leading to predictable results. By default this setting is disabled, making the model to consider all choices.

verbosityenumoptional

Controls the verbosity and length of the model response. Lower values produce more concise responses, while higher values produce more detailed and comprehensive responses.

Variants
"low"
"medium"
"high"
profilearray*required

The profile to use for the completion. Must be of the same length as the Ensemble's llms field, ignoring count.

Items
number
descriptionstring*required

The description of the profile.

changelogstringoptional

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

Objective Artificial Intelligence, Inc.