Modify Assistant

Supported Providers

• OpenAI

Modifies an assistant.

post

Authorizations

Portkey-KeyVirtual-KeyProvider-AuthProvider-NameConfigCustom-Host

Path parameters

assistant_idstringRequired

The ID of the assistant to modify.

Body

modelany ofOptional

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.

stringOptional

namestring | nullableOptional

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

descriptionstring | nullableOptional

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

instructionsstring | nullableOptional

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

metadataobject | nullableOptional

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.

temperaturenumber | nullableOptional

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: 1Example: 1

top_pnumber | nullableOptional

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: 1Example: 1

response_formatone of | nullableOptional

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

Setting to { "type": "json_object" } enables JSON mode, which guarantees 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.

string · enumOptional

auto is the default value

Possible values:

or

Responses

200

OK

application/json

post

curlpythonjavascript

curl https://api.portkey.ai/v1/assistants/asst_abc123 \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -H "OpenAI-Beta: assistants=v2" \
  -d '{
      "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
      "tools": [{"type": "file_search"}],
      "model": "gpt-4-turbo"
    }'

200

OK

{
  "id": "text",
  "object": "assistant",
  "created_at": 1,
  "name": "text",
  "description": "text",
  "model": "text",
  "instructions": "text",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "text"
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "text"
      ]
    }
  },
  "metadata": {},
  "temperature": 1,
  "top_p": 1,
  "response_format": "none"
}