CreateMessageRequest
objectThe role of the entity that is creating the message. Allowed values include:
user: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.assistant: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.
Allowed values:userassistant
One OfThe text contents of the message.
A list of files attached to the message, and the tools they should be added to.
Show Child Parameters
Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
CreateModerationRequest
objectOne OfInput (or inputs) to classify. Can be a single string, an array of strings, or
an array of multi-modal input objects similar to other models.
A string of text to classify for moderation.
Default:
Example:I want to kill them.
Any OfThe content moderation model you would like to use. Learn more in
the moderation guide, and learn about
available models here.
Default:omni-moderation-latest
Example:omni-moderation-2024-09-26
CreateModerationResponse
objectRepresents if a given text input is potentially harmful.
The unique identifier for the moderation request.
The model used to generate the moderation results.
A list of moderation objects.
Show Child Parameters
CreateRunRequest
objectThe ID of the assistant to use to execute this run.
Any OfThe ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.
Example:gpt-4o
o1 and o3-mini models only
Constrains effort on reasoning for
reasoning models.
Currently supported values are low, medium, and high. Reducing
reasoning effort can result in faster responses and fewer tokens used
on reasoning in a response.
Allowed values:lowmediumhigh
Default:medium
Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.
Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.
Adds additional messages to the thread before creating the run.
Show Child Parameters
One OfOverride the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.
<= 20 items
Show Child Parameters
Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
Default:1
>= 0<= 2
Example:1
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
We generally recommend altering this or temperature but not both.
Default:1
>= 0<= 1
Example:1
If true, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a data: [DONE] message.
The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status incomplete. See incomplete_details for more info.
>= 256
The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status incomplete. See incomplete_details for more info.
>= 256
Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.
Show Child Parameters
One Ofnone means the model will not call any tools and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user.
Allowed values:noneautorequired
One Ofauto is the default value
Allowed values:auto
CreateSpeechRequest
objectAny OfOne of the available TTS models: tts-1 or tts-1-hd
The text to generate audio for. The maximum length is 4096 characters.
<= 4096 characters
The voice to use when generating the audio. Supported voices are alloy, ash, coral, echo, fable, onyx, nova, sage and shimmer. Previews of the voices are available in the Text to speech guide.
Allowed values:alloyashcoralechofableonyxnovasageshimmer
The format to audio in. Supported formats are mp3, opus, aac, flac, wav, and pcm.
Allowed values:mp3opusaacflacwavpcm
Default:mp3
The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.
Default:1
>= 0.25<= 4