thread_idstringrequired
The ID of the thread that was run.
run_idstringrequired
The ID of the run to retrieve.
Retrieves a run.
get
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}
Path Parameters
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
get/threads/{thread_id}/runs/{run_id}
Authentication
Path Parameters
200 application/json
Modifies a run.
post
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}
Path Parameters
thread_idstringrequired
The ID of the thread that was run.
run_idstringrequired
The ID of the run to modify.
Body
application/json
Body
application/json
ModifyRunRequest
* Additional properties are NOT allowed.
metadataobject | null
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.
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}
Authentication
Path Parameters
Body
{}
200 application/json
Cancels a run that is `in_progress`.
post
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/cancel
Path Parameters
thread_idstringrequired
The ID of the thread to which this run belongs.
run_idstringrequired
The ID of the run to cancel.
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}/cancel
Authentication
Path Parameters
200 application/json
Returns a list of run steps belonging to a run.
get
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/steps
Query Parameters
limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
Default:20
orderstring
Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
Allowed values:ascdesc
Default:desc
afterstring
A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
beforestring
A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
include[]array[string]
A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content.
See the file search tool documentation for more information.
Allowed values:step_details.tool_calls[*].file_search.results[*].content
Path Parameters
thread_idstringrequired
The ID of the thread the run and run steps belong to.
run_idstringrequired
The ID of the run the run steps belong to.
Response
200 application/json
Response
200 application/json
OK
ListRunStepsResponse
objectstringrequired
Example:list
dataarray[object]required
Represents a step in execution of a run.
Show Child Parameters
first_idstringrequired
Example:step_abc123
last_idstringrequired
Example:step_abc456
has_morebooleanrequired
Example:false
get/threads/{thread_id}/runs/{run_id}/steps
Authentication
Path Parameters
Query Parameters
200 application/json
Retrieves a run step.
get
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}
Query Parameters
include[]array[string]
A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content.
See the file search tool documentation for more information.
Allowed values:step_details.tool_calls[*].file_search.results[*].content
Path Parameters
thread_idstringrequired
The ID of the thread to which the run and run step belongs.
run_idstringrequired
The ID of the run to which the run step belongs.
step_idstringrequired
The ID of the run step to retrieve.
Response
200 application/json
Response
200 application/json
OK
Run steps
Represents a step in execution of a run.
idstringrequired
The identifier of the run step, which can be referenced in API endpoints.
objectstringrequired
The object type, which is always thread.run.step.
Allowed values:thread.run.step
created_atintegerrequired
The Unix timestamp (in seconds) for when the run step was created.
assistant_idstringrequired
The ID of the assistant associated with the run step.
thread_idstringrequired
The ID of the thread that was run.
run_idstringrequired
The ID of the run that this run step is a part of.
typestringrequired
The type of run step, which can be either message_creation or tool_calls.
Allowed values:message_creationtool_calls
statusstringrequired
The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.
Allowed values:in_progresscancelledfailedcompletedexpired
step_details
One Ofobjectrequired
The details of the run step.
Message creationobject
Details of the message creation by the run step.
Show Child Parameters
last_errorobject | nullrequired
The last error associated with this run step. Will be null if there are no errors.
Show Child Parameters
expired_atinteger | nullrequired
The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.
cancelled_atinteger | nullrequired
The Unix timestamp (in seconds) for when the run step was cancelled.
failed_atinteger | nullrequired
The Unix timestamp (in seconds) for when the run step failed.
completed_atinteger | nullrequired
The Unix timestamp (in seconds) for when the run step completed.
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 step. This value will be null while the run step’s status is in_progress.
Show Child Parameters
get/threads/{thread_id}/runs/{run_id}/steps/{step_id}
Authentication
Path Parameters
Query Parameters
200 application/json