thread_idstringrequired
The ID of the thread to which this message belongs.
message_idstringrequired
The ID of the message to retrieve.
Retrieve a message.
get
https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}
Path Parameters
Response
200 application/json
Response
200 application/json
OK
The message object
Represents a message within a thread.
idstringrequired
The identifier, which can be referenced in API endpoints.
objectstringrequired
The object type, which is always thread.message.
Allowed values:thread.message
created_atintegerrequired
The Unix timestamp (in seconds) for when the message was created.
thread_idstringrequired
The thread ID that this message belongs to.
statusstringrequired
The status of the message, which can be either in_progress, incomplete, or completed.
Allowed values:in_progressincompletecompleted
incomplete_detailsobject | nullrequired
On an incomplete message, details about why the message is incomplete.
Show Child Parameters
completed_atinteger | nullrequired
The Unix timestamp (in seconds) for when the message was completed.
incomplete_atinteger | nullrequired
The Unix timestamp (in seconds) for when the message was marked as incomplete.
rolestringrequired
The entity that produced the message. One of user or assistant.
Allowed values:userassistant
content
One Ofarrayrequired
The content of the message in array of text and/or images.
Image fileobject
References an image File in the content of a message.
Show Child Parameters
assistant_idstring | nullrequired
If applicable, the ID of the assistant that authored this message.
run_idstring | nullrequired
The ID of the run associated with the creation of this message. Value is null when messages are created manually using the create message or create thread endpoints.
attachmentsarray | null[object]required
A list of files attached to the message, and the tools they were added to.
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.
get/threads/{thread_id}/messages/{message_id}
Authentication
Path Parameters
200 application/json
Modifies a message.
post
https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}
Path Parameters
thread_idstringrequired
The ID of the thread to which this message belongs.
message_idstringrequired
The ID of the message to modify.
Body
application/json
Body
application/json
ModifyMessageRequest
* 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
The message object
Represents a message within a thread.
idstringrequired
The identifier, which can be referenced in API endpoints.
objectstringrequired
The object type, which is always thread.message.
Allowed values:thread.message
created_atintegerrequired
The Unix timestamp (in seconds) for when the message was created.
thread_idstringrequired
The thread ID that this message belongs to.
statusstringrequired
The status of the message, which can be either in_progress, incomplete, or completed.
Allowed values:in_progressincompletecompleted
incomplete_detailsobject | nullrequired
On an incomplete message, details about why the message is incomplete.
Show Child Parameters
completed_atinteger | nullrequired
The Unix timestamp (in seconds) for when the message was completed.
incomplete_atinteger | nullrequired
The Unix timestamp (in seconds) for when the message was marked as incomplete.
rolestringrequired
The entity that produced the message. One of user or assistant.
Allowed values:userassistant
content
One Ofarrayrequired
The content of the message in array of text and/or images.
Image fileobject
References an image File in the content of a message.
Show Child Parameters
assistant_idstring | nullrequired
If applicable, the ID of the assistant that authored this message.
run_idstring | nullrequired
The ID of the run associated with the creation of this message. Value is null when messages are created manually using the create message or create thread endpoints.
attachmentsarray | null[object]required
A list of files attached to the message, and the tools they were added to.
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.
post/threads/{thread_id}/messages/{message_id}
Authentication
Path Parameters
Body
{}
200 application/json
Deletes a message.
delete
https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}
Path Parameters
thread_idstringrequired
The ID of the thread to which this message belongs.
message_idstringrequired
The ID of the message to delete.
Response
200 application/json
Response
200 application/json
OK
DeleteMessageResponse
idstringrequired
deletedbooleanrequired
objectstringrequired
Allowed values:thread.message.deleted
delete/threads/{thread_id}/messages/{message_id}
Authentication
Path Parameters
200 application/json
Returns a list of runs belonging to a thread.
get
https://api.openai.com/v1/threads/{thread_id}/runs
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.
Path Parameters
thread_idstringrequired
The ID of the thread the run belongs to.
Response
200 application/json
Response
200 application/json
OK
ListRunsResponse
objectstringrequired
Example:list
dataarray[object]required
Represents an execution run on a thread.
Show Child Parameters
first_idstringrequired
Example:run_abc123
last_idstringrequired
Example:run_abc456
has_morebooleanrequired
Example:false
get/threads/{thread_id}/runs
Authentication
Path Parameters
Query Parameters
200 application/json
Create a run.
post
https://api.openai.com/v1/threads/{thread_id}/runs
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 run.
Body
application/json
Body
application/json
CreateRunRequest
* Additional properties are NOT allowed.
assistant_idstringrequired
The ID of the assistant to use to execute this run.
model
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
Variant 1string
reasoning_effortstring | null
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
instructionsstring | null
Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.
additional_instructionsstring | null
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.
additional_messagesarray | null[object]
Adds additional messages to the thread before creating the run.
* Additional properties are NOT allowed.
Show Child Parameters
tools
One Ofarray | null
Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.
<= 20 items
Code interpreter toolobject
Show Child Parameters
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.
temperaturenumber | null
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
top_pnumber | null
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
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.
max_prompt_tokensinteger | null
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
max_completion_tokensinteger | null
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
truncation_strategyobject
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 OfAssistantsApiToolChoiceOptionstring
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
response_format
One OfAssistantsApiResponseFormatOptionstring
auto is the default value
Allowed values:auto
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
Authentication
Path Parameters
Query Parameters
Body
{
"assistant_id": "assistant_id"
}
200 application/json