Assistants

Update Assistant

Update an assistant's attributes, including its name, description, and tools. Note: The 'tools' field will replace the existing list of tools. Embedding model cannot be changed after creation.

put/assistants/{assistant_id}

Path parameters

assistant_idstring uuid required

Headers

authorizationstring nullable

x_session_tokenstring nullable

Request body

namestring nullable

New name for the assistant

system_promptstring nullable

New system prompt (alias for description)

tok_kinteger nullable

Document search top_k for the internal search_documents tool.

custom_fact_extraction_promptstring nullable

Custom prompt for fact extraction from conversations. Set to empty string to clear.

custom_update_memory_promptstring nullable

Custom prompt for memory update decisions. Set to empty string to clear.

Response

Successful Response

namestring required

Name of the assistant

system_promptstring nullable

Optional system prompt (alias for description)

tok_kinteger

Document search top_k for the internal search_documents tool (default 10).

embedding_providerstring nullable

Embedding provider (openai, google, cohere, etc.)

embedding_model_namestring nullable

Embedding model name (e.g., text-embedding-3-large, text-embedding-004)

embedding_dimsinteger nullable

Embedding dimensions (e.g., 1024 for Cohere, 3072 for OpenAI text-embedding-3-large)

custom_fact_extraction_promptstring nullable

Custom prompt for fact extraction from conversations. If not set, the default prompt is used.

custom_update_memory_promptstring nullable

Custom prompt for memory update decisions (add/update/delete). If not set, the default prompt is used.

assistant_idstring uuid required

created_atstring date-time required

Changes

No recorded changes to this endpoint across all 1 revision of this API.