Search
K
OpenAI API

MessageStreamEvent

One Of
eventstringrequired

Allowed values:thread.message.created

dataobjectrequired

Represents a message within a thread.

Show Child Parameters
Example

Metadata

object

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.

Model

Describes an OpenAI model offering that can be used with the API.

idstringrequired

The model identifier, which can be referenced in the API endpoints.

createdintegerrequired

The Unix timestamp (in seconds) when the model was created.

objectstringrequired

The object type, which is always “model”.

Allowed values:model

owned_bystringrequired

The organization that owns the model.

Example

ModifyAssistantRequest

object
* Additional properties are NOT allowed.
modelAny Of

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

Variant 1string
reasoning_effortstring

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

namestring

The name of the assistant. The maximum length is 256 characters.

<= 256 characters

descriptionstring

The description of the assistant. The maximum length is 512 characters.

<= 512 characters

instructionsstring

The system instructions that the assistant uses. The maximum length is 256,000 characters.

<= 256000 characters

toolsOne Of
array

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

Default:[]

<= 128 items

Code interpreter toolobject
Show Child Parameters
tool_resourcesobject

A set of resources that are used by the assistant’s tools. 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
metadataobject

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

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

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

response_formatOne Of
AssistantsApiResponseFormatOptionstring

auto is the default value

Allowed values:auto

Example

ModifyMessageRequest

object
* Additional properties are NOT allowed.
metadataobject

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.

Example