CreateThreadAndRunRequest
objectThe ID of the assistant to use to execute this run.
Options to create a new thread. If no thread is provided when running a
request, an empty thread will be created.
Show Child Parameters
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
Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.
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
A set of resources that are used by the assistant’s tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.
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
CreateThreadRequest
objectOptions to create a new thread. If no thread is provided when running a
request, an empty thread will be created.
A list of messages to start the thread with.
Show Child Parameters
A set of resources that are made available to the assistant’s tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.
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.
CreateTranscriptionRequest
objectThe audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
Any OfID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.
Example:whisper-1
The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.
An optional text to guide the model’s style or continue a previous audio segment. The prompt should match the audio language.
The format of the output, in one of these options: json, text, srt, verbose_json, or vtt.
Allowed values:jsontextsrtverbose_jsonvtt
Default:json
The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.
Default:0
The timestamp granularities to populate for this transcription. response_format must be set verbose_json to use timestamp granularities. Either or both of these options are supported: word, or segment. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.
Allowed values:wordsegment
Default:segment
CreateTranscriptionResponseJson
objectRepresents a transcription response returned by model, based on the provided input.
The transcribed text.
CreateTranscriptionResponseVerboseJson
objectRepresents a verbose json transcription response returned by model, based on the provided input.
The language of the input audio.
The duration of the input audio.
The transcribed text.
Extracted words and their corresponding timestamps.
Show Child Parameters
Segments of the transcribed text and their corresponding details.