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
The ID of the thread to run.
The 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.
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
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.
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
OK
Represents an execution run on a thread.
The identifier, which can be referenced in API endpoints.
The object type, which is always thread.run.
Allowed values:thread.run
The Unix timestamp (in seconds) for when the run was created.
The ID of the thread that was executed on as a part of this run.
The ID of the assistant used for execution of this run.
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
Details on the action required to continue the run. Will be null if no action is required.
The last error associated with this run. Will be null if there are no errors.
The Unix timestamp (in seconds) for when the run will expire.
The Unix timestamp (in seconds) for when the run was started.
The Unix timestamp (in seconds) for when the run was cancelled.
The Unix timestamp (in seconds) for when the run failed.
The Unix timestamp (in seconds) for when the run was completed.
Details on why the run is incomplete. Will be null if the run is not incomplete.
The model that the assistant used for this run.
The instructions that the assistant used for this run.
One OfThe list of tools that the assistant used for this run.
Default:[]
<= 20 items
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.
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.).
The sampling temperature used for this run. If not set, defaults to 1.
The nucleus sampling value used for this run. If not set, defaults to 1.
The maximum number of prompt tokens specified to have been used over the course of the run.
>= 256
The maximum number of completion tokens specified to have been used over the course of the run.
>= 256
Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.
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
Whether to enable parallel function calling during tool use.
Default:true
One Ofauto is the default value
Allowed values:auto
The ID of the thread that was run.
The ID of the run to retrieve.
OK
Represents an execution run on a thread.
The identifier, which can be referenced in API endpoints.
The object type, which is always thread.run.
Allowed values:thread.run
The Unix timestamp (in seconds) for when the run was created.
The ID of the thread that was executed on as a part of this run.
The ID of the assistant used for execution of this run.
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
Details on the action required to continue the run. Will be null if no action is required.
The last error associated with this run. Will be null if there are no errors.
The Unix timestamp (in seconds) for when the run will expire.
The Unix timestamp (in seconds) for when the run was started.
The Unix timestamp (in seconds) for when the run was cancelled.
The Unix timestamp (in seconds) for when the run failed.
The Unix timestamp (in seconds) for when the run was completed.
Details on why the run is incomplete. Will be null if the run is not incomplete.
The model that the assistant used for this run.
The instructions that the assistant used for this run.
One OfThe list of tools that the assistant used for this run.
Default:[]
<= 20 items
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.
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.).
The sampling temperature used for this run. If not set, defaults to 1.
The nucleus sampling value used for this run. If not set, defaults to 1.
The maximum number of prompt tokens specified to have been used over the course of the run.
>= 256
The maximum number of completion tokens specified to have been used over the course of the run.
>= 256
Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.
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
Whether to enable parallel function calling during tool use.
Default:true
One Ofauto is the default value
Allowed values:auto
The ID of the thread that was run.
The ID of the run to modify.
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.
OK
Represents an execution run on a thread.
The identifier, which can be referenced in API endpoints.
The object type, which is always thread.run.
Allowed values:thread.run
The Unix timestamp (in seconds) for when the run was created.
The ID of the thread that was executed on as a part of this run.
The ID of the assistant used for execution of this run.
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
Details on the action required to continue the run. Will be null if no action is required.
The last error associated with this run. Will be null if there are no errors.
The Unix timestamp (in seconds) for when the run will expire.
The Unix timestamp (in seconds) for when the run was started.
The Unix timestamp (in seconds) for when the run was cancelled.
The Unix timestamp (in seconds) for when the run failed.
The Unix timestamp (in seconds) for when the run was completed.
Details on why the run is incomplete. Will be null if the run is not incomplete.
The model that the assistant used for this run.
The instructions that the assistant used for this run.
One OfThe list of tools that the assistant used for this run.
Default:[]
<= 20 items
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.
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.).
The sampling temperature used for this run. If not set, defaults to 1.
The nucleus sampling value used for this run. If not set, defaults to 1.
The maximum number of prompt tokens specified to have been used over the course of the run.
>= 256
The maximum number of completion tokens specified to have been used over the course of the run.
>= 256
Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.
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
Whether to enable parallel function calling during tool use.
Default:true
One Ofauto is the default value
Allowed values:auto
The ID of the thread to which this run belongs.
The ID of the run to cancel.
OK
Represents an execution run on a thread.
The identifier, which can be referenced in API endpoints.
The object type, which is always thread.run.
Allowed values:thread.run
The Unix timestamp (in seconds) for when the run was created.
The ID of the thread that was executed on as a part of this run.
The ID of the assistant used for execution of this run.
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
Details on the action required to continue the run. Will be null if no action is required.
The last error associated with this run. Will be null if there are no errors.
The Unix timestamp (in seconds) for when the run will expire.
The Unix timestamp (in seconds) for when the run was started.
The Unix timestamp (in seconds) for when the run was cancelled.
The Unix timestamp (in seconds) for when the run failed.
The Unix timestamp (in seconds) for when the run was completed.
Details on why the run is incomplete. Will be null if the run is not incomplete.
The model that the assistant used for this run.
The instructions that the assistant used for this run.
One OfThe list of tools that the assistant used for this run.
Default:[]
<= 20 items
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.
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.).
The sampling temperature used for this run. If not set, defaults to 1.
The nucleus sampling value used for this run. If not set, defaults to 1.
The maximum number of prompt tokens specified to have been used over the course of the run.
>= 256
The maximum number of completion tokens specified to have been used over the course of the run.
>= 256
Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.
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
Whether to enable parallel function calling during tool use.
Default:true
One Ofauto is the default value
Allowed values:auto
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
Default:20
Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
Allowed values:ascdesc
Default:desc
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.
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.
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
The ID of the thread the run and run steps belong to.
The ID of the run the run steps belong to.
OK
Example:list
Represents a step in execution of a run.
Example:step_abc123
Example:step_abc456
Example:false