---
title: "Modify Assistant"
method: PATCH
path: "/studio/v1/assistants/{assistant_id}"
---

# Modify Assistant

`PATCH /studio/v1/assistants/{assistant_id}`

## Path parameters

- `assistant_id` string, required

## Request body

- ModifyAssistantRequest
  - `name` string
  - `description` string
  - `optimization` 'cost' | 'latency' — An enumeration.
  - `avatar` string
  - `is_archived` boolean
  - `models` string[]
  - `tools` LanguageStudioApiServerDataTypesExecutionEngineToolDefinition[]
    - union
      - HTTPToolResource
        - `type` 'http'
        - `function` HTTPToolFunction, required
          - `name` string, required
          - `description` string, required
          - `parameters` HTTPToolFunctionParameters, required
            - `type` 'object'
            - `properties` object, required
            - `required` string[], required
            - `additionalProperties` boolean
        - `endpoint` HTTPToolEndpoint, required
          - `url` string, required
          - `headers` object
      - MCPToolResource
        - `type` 'mcp'
        - `server_label` string
        - `server_url` string
        - `headers` object
        - `allowed_tools` string[]
        - `mcp_id` string
      - FileSearchToolResource
        - `type` 'file_search'
        - `retrieval_similarity_threshold` number
        - `labels` string[]
        - `labels_filter_mode` 'AND' | 'OR'
        - `labels_filter` union
          - ComparisonOperator
          - LogicalOperator
          - object
        - `file_ids` string[]
        - `retrieval_strategy` 'segments' | 'default' | 'add_neighbors' | 'full_doc' — An enumeration.
        - `max_neighbors` integer
        - `path` string
        - `response_language` 'arabic' | 'dutch' | 'english' | 'french' | 'german' | 'hebrew' | 'italian' | 'portuguese' | 'spanish' | 'unset'
        - `hybrid_search_alpha` number
        - `use_two_step_embedders` boolean
      - WebSearchToolResource
        - `type` 'web_search'
        - `urls` string[]
        - `fallback_to_web` boolean
        - `query_suffix` string
        - `rephrase_query` boolean
        - `use_cached_pages` boolean
  - `requirements` LanguageStudioApiServerDataTypesAssistantRequirement[]
    - `id` string — A unique ID for the request (not the message). Repeated identical requests get different IDs. However, for a streaming response, the ID will be the same for all responses in the stream.
    - `title` string
    - `description` string
    - `type` string
  - `budget` 'low' | 'medium' | 'high' — An enumeration.
  - `visibility` 'public' | 'private' — An enumeration.
  - `response_language` 'arabic' | 'dutch' | 'english' | 'french' | 'german' | 'hebrew' | 'italian' | 'portuguese' | 'spanish' | 'unset'
  - `system_prompt` string
  - `workflow_config` WorkflowConfig
    - `endpoint_url` string, required
    - `headers` object
    - `additional_params` object
  - `config_overrides` object

## Response `200`

Successful Response

- Assistant
  - `id` string, required — A unique ID for the request (not the message). Repeated identical requests get different IDs. However, for a streaming response, the ID will be the same for all responses in the stream.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `object` string, required
  - `name` string, required
  - `description` string
  - `optimization` string
  - `organization_id` string, required
  - `workspace_id` string
  - `user_id` string, required
  - `avatar` string
  - `is_archived` boolean
  - `models` union
    - string[]
    - string[]
  - `tools` LanguageStudioApiServerDataTypesExecutionEngineToolDefinition[]
    - union
      - HTTPToolResource
        - `type` 'http'
        - `function` HTTPToolFunction, required
          - `name` string, required
          - `description` string, required
          - `parameters` HTTPToolFunctionParameters, required
            - `type` 'object'
            - `properties` object, required
            - `required` string[], required
            - `additionalProperties` boolean
        - `endpoint` HTTPToolEndpoint, required
          - `url` string, required
          - `headers` object
      - MCPToolResource
        - `type` 'mcp'
        - `server_label` string
        - `server_url` string
        - `headers` object
        - `allowed_tools` string[]
        - `mcp_id` string
      - FileSearchToolResource
        - `type` 'file_search'
        - `retrieval_similarity_threshold` number
        - `labels` string[]
        - `labels_filter_mode` 'AND' | 'OR'
        - `labels_filter` union
          - ComparisonOperator
          - LogicalOperator
          - object
        - `file_ids` string[]
        - `retrieval_strategy` 'segments' | 'default' | 'add_neighbors' | 'full_doc' — An enumeration.
        - `max_neighbors` integer
        - `path` string
        - `response_language` 'arabic' | 'dutch' | 'english' | 'french' | 'german' | 'hebrew' | 'italian' | 'portuguese' | 'spanish' | 'unset'
        - `hybrid_search_alpha` number
        - `use_two_step_embedders` boolean
      - WebSearchToolResource
        - `type` 'web_search'
        - `urls` string[]
        - `fallback_to_web` boolean
        - `query_suffix` string
        - `rephrase_query` boolean
        - `use_cached_pages` boolean
  - `requirements` LanguageStudioApiServerDataTypesAssistantRequirement[]
    - `id` string — A unique ID for the request (not the message). Repeated identical requests get different IDs. However, for a streaming response, the ID will be the same for all responses in the stream.
    - `title` string
    - `description` string
    - `type` string
  - `budget` 'low' | 'medium' | 'high' — An enumeration.
  - `visibility` 'public' | 'private' — An enumeration.
  - `assistant_type` 'default' | 'chat' | 'maestro' — An enumeration.
  - `response_language` 'arabic' | 'dutch' | 'english' | 'french' | 'german' | 'hebrew' | 'italian' | 'portuguese' | 'spanish' | 'unset'
  - `vibe_prompt` string
  - `starter_questions` StarterQuestion[]
    - `title` string, required
    - `prompt` string, required
  - `system_prompt` string
  - `workflow_config` WorkflowConfig
    - `endpoint_url` string, required
    - `headers` object
    - `additional_params` object
  - `config_overrides` object

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/ai21/apis/ai21-studio-api.md) · [All operations](https://skmtc.net/ai21/apis/ai21-studio-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ai21/ai21-studio-api/versions/4105747cd57d/schema)