POST /assistants
Servers
- https://api.openai.com/v1
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
name |
String | No |
The name of the assistant. The maximum length is 256 characters. |
description |
String | No |
The description of the assistant. The maximum length is 512 characters. |
temperature |
Number | No |
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 value: 1 |
tools[] |
Array | No |
A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types |
metadata |
Object | No |
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. |
tool_resources |
Object | No |
A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the |
tool_resources.code_interpreter |
Object | No | |
tool_resources.code_interpreter.file_ids[] |
Array | No |
A list of file IDs made available to the |
tool_resources.file_search |
Object | No | |
tool_resources.file_search.vector_stores[] |
Array | No |
A helper to create a vector store with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant. |
tool_resources.file_search.vector_stores[].file_ids[] |
Array | No |
A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. |
tool_resources.file_search.vector_stores[].metadata |
Object | No |
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. |
tool_resources.file_search.vector_stores[].chunking_strategy |
Object | No |
The chunking strategy used to chunk the file(s). If not set, will use the |
tool_resources.file_search.vector_store_ids[] |
Array | No |
The vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. |
response_format |
No |
Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since Setting to Setting to 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 |
|
model |
Yes |
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. |
|
top_p |
Number | No |
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 value: 1 |
instructions |
String | No |
The system instructions that the assistant uses. The maximum length is 256,000 characters. |
reasoning_effort |
String | No |
o-series models only Constrains effort on reasoning for
reasoning models.
Currently supported values are Possible values:
Default value: "medium" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.