Skip to main content
PATCH
/
v1
/
assistants
/
{assistant_id}
Modify an assistant
curl --request PATCH \
  --url https://api.zerobot.ai/v1/assistants/{assistant_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "name": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "tools": [],
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    },
    "file_search": {
      "vector_store_ids": [
        "<string>"
      ],
      "vector_stores": [
        {
          "file_ids": [
            "<string>"
          ],
          "metadata": {}
        }
      ]
    }
  },
  "metadata": {},
  "temperature": 1,
  "top_p": 1,
  "response_format": "auto"
}
'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
model
string

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.

​
name
string

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

Maximum string length: 256
​
description
string

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

Maximum string length: 512
​
instructions
string

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

Maximum string length: 256000
​
tools
object[]

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.

Maximum array length: 128
  • Option 1
  • Option 2
  • Option 3
​
tool_resources
object

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.

​
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. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

​
temperature
number
default:1

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.

Required range: 0 <= x <= 2
​
top_p
number
default: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.

​
response_format
default:auto

Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

Response

200 - application/json

Successful response

The modified assistant object.