thread_idstringrequired
The ID of the thread to which this run belongs.
run_idstringrequired
The ID of the run that requires the tool output submission.
When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
post
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs
Path Parameters
Body
application/json
Body
application/json
SubmitToolOutputsRunRequest
* Additional properties are NOT allowed.
tool_outputsarray[object]required
A list of tools for which the outputs are being submitted.
Show Child Parameters
streamboolean | null
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.
Response
200 application/json
Response
200 application/json
OK
A run on a thread
Represents an execution run on a thread.
idstringrequired
The identifier, which can be referenced in API endpoints.
objectstringrequired
The object type, which is always thread.run.
Allowed values:thread.run
created_atintegerrequired
The Unix timestamp (in seconds) for when the run was created.
thread_idstringrequired
The ID of the thread that was executed on as a part of this run.
assistant_idstringrequired
The ID of the assistant used for execution of this run.
statusstringrequired
The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.
Allowed values:queuedin_progressrequires_actioncancellingcancelledfailedcompletedincompleteexpired
required_actionobject | nullrequired
Details on the action required to continue the run. Will be null if no action is required.
Show Child Parameters
last_errorobject | nullrequired
The last error associated with this run. Will be null if there are no errors.
Show Child Parameters
expires_atinteger | nullrequired
The Unix timestamp (in seconds) for when the run will expire.
started_atinteger | nullrequired
The Unix timestamp (in seconds) for when the run was started.
cancelled_atinteger | nullrequired
The Unix timestamp (in seconds) for when the run was cancelled.
failed_atinteger | nullrequired
The Unix timestamp (in seconds) for when the run failed.
completed_atinteger | nullrequired
The Unix timestamp (in seconds) for when the run was completed.
incomplete_detailsobject | nullrequired
Details on why the run is incomplete. Will be null if the run is not incomplete.
Show Child Parameters
modelstringrequired
The model that the assistant used for this run.
instructionsstringrequired
The instructions that the assistant used for this run.
tools
One Ofarrayrequired
The list of tools that the assistant used for this run.
Default:[]
<= 20 items
Code interpreter toolobject
Show Child Parameters
metadataobject | nullrequired
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.
usageobject | nullrequired
Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.).
Show Child Parameters
temperaturenumber | null
The sampling temperature used for this run. If not set, defaults to 1.
top_pnumber | null
The nucleus sampling value used for this run. If not set, defaults to 1.
max_prompt_tokensinteger | nullrequired
The maximum number of prompt tokens specified to have been used over the course of the run.
>= 256
max_completion_tokensinteger | nullrequired
The maximum number of completion tokens specified to have been used over the course of the run.
>= 256
truncation_strategyobjectrequired
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
tool_choice
One Ofrequired
AssistantsApiToolChoiceOptionstring
none 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
parallel_tool_callsbooleanrequired
Whether to enable parallel function calling during tool use.
Default:true
response_format
One Ofrequired
AssistantsApiResponseFormatOptionstring
auto is the default value
Allowed values:auto
post/threads/{thread_id}/runs/{run_id}/submit_tool_outputs
Authentication
Path Parameters
Body
{
"tool_outputs": [
{}
]
}
200 application/json
Audio
Turn audio into text or text into audio.
Generates audio from the input text.
post
https://api.openai.com/v1/audio/speech
Body
application/json
Body
application/json
CreateSpeechRequest
* Additional properties are NOT allowed.
model
Any Ofrequired
One of the available TTS models: tts-1 or tts-1-hd
Variant 1string
inputstringrequired
The text to generate audio for. The maximum length is 4096 characters.
<= 4096 characters
voicestringrequired
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
response_formatstring
The format to audio in. Supported formats are mp3, opus, aac, flac, wav, and pcm.
Allowed values:mp3opusaacflacwavpcm
Default:mp3
speednumber
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
Response
200 application/octet-stream
Response
200 application/octet-stream
OK
string
post/audio/speech
Authentication
Body
{
"model": {},
"input": "input",
"voice": "alloy"
}
200 application/octet-stream
Transcribes audio into the input language.
post
https://api.openai.com/v1/audio/transcriptions
Body
multipart/form-data
Body
multipart/form-data
CreateTranscriptionRequest
* Additional properties are NOT allowed.
filestringrequired
The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
model
Any Ofrequired
ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.
Example:whisper-1
Variant 1string
languagestring
The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.
promptstring
An optional text to guide the model’s style or continue a previous audio segment. The prompt should match the audio language.
response_formatstring
The format of the output, in one of these options: json, text, srt, verbose_json, or vtt.
Allowed values:jsontextsrtverbose_jsonvtt
Default:json
temperaturenumber
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
timestamp_granularities[]array[string]
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
Response
200 application/json
Response
200 application/json
OK
One Oftextstringrequired
The transcribed text.
post/audio/transcriptions
Authentication
Body
{
"file": "file",
"model": {}
}
200 application/json
Translates audio into English.
post
https://api.openai.com/v1/audio/translations
Body
multipart/form-data
Body
multipart/form-data
CreateTranslationRequest
* Additional properties are NOT allowed.
filestringrequired
The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
model
Any Ofrequired
ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.
Example:whisper-1
Variant 1string
promptstring
An optional text to guide the model’s style or continue a previous audio segment. The prompt should be in English.
response_formatstring
The format of the output, in one of these options: json, text, srt, verbose_json, or vtt.
Allowed values:jsontextsrtverbose_jsonvtt
Default:json
temperaturenumber
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
Response
200 application/json
Response
200 application/json
OK
One Oftextstringrequired
post/audio/translations
Authentication
Body
{
"file": "file",
"model": {}
}
200 application/json