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.
Show Child Parameters
CreateTranslationRequest
objectThe audio file object (not file name) translate, 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
An optional text to guide the model’s style or continue a previous audio segment. The prompt should be in English.
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