GET
/assistants/{assistant_id}DeprecatedRetrieve an assistant
Retrieves a single assistant by its identifier. Returns the full assistant configuration including model, instructions, tools, and all other settings. Use this to fetch the current state of an assistant before modifying it.
assistant_idstringrequired
The unique identifier of the assistant to retrieve.
200Returns the assistant object with its complete configuration, including id, model, name, instructions, tools, and metadata.
idstringrequired
The identifier, which can be referenced in API endpoints.
objectstringrequired
The object type, which is always `assistant`.
created_atintegerrequired
The Unix timestamp (in seconds) for when the assistant was created.
namestringrequired
The name of the assistant. The maximum length is 256 characters.
descriptionstringrequired
The description of the assistant. The maximum length is 512 characters.
modelstringrequired
ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.
instructionsstringrequired
The system instructions that the assistant uses. The maximum length is 256,000 characters.
toolsarray<CodeInterpreterTool>required
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`.
tool_resourcesobjectoptional
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.
metadataobjectrequired
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.
temperaturenumberoptional
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.
top_pnumberoptional
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.
response_formatstring | objectoptional
Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](/docs/guides/structured-outputs).
Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON.
**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.
429Returned when the request rate limit is exceeded.
errorobjectrequired
Error handling
assistant_id must identify an existing assistant. A 429 is returned when the request rate limit is exceeded.