Skip to content
/
Update assistant
Last updated

Update assistant

Update an existing assistant's configuration, tools, and settings.

PUThttps://api.aitronos.com/v1/assistants/{assistant_id}

Path Parameters

assistant_id string required

The unique identifier of the assistant to update.

Request Body

name string optional

The name of the assistant. Must be unique within the organization.

description string optional

A brief description of the assistant's purpose and capabilities.

default_model_key string optional

The AI model key to use for this assistant. View available models →

instructions string optional

System instructions that define the assistant's behavior and personality.

avatar_id string optional

Predefined avatar identifier from the Aitronos avatar library. View available avatars →

tool_configurations object optional

Configuration for built-in system tools and external integrations. See Assistant object for full structure.

system_message array optional

Pre-configured system messages or input examples. An array of input message objects with texts, images, or files.

context_strategy string optional · Defaults to auto

Sets the overall thread context management strategy. Values: full, off, auto, saver.

max_tool_calls integer optional

Maximum number of built-in tool calls allowed per response.

parallel_tool_calls boolean optional

Whether the assistant can execute multiple tool calls simultaneously.

access_mode string optional

Access control for the assistant. One of private, organization, public.

temperature number optional

Controls randomness in responses (0.0 to 1.0).

max_completion_tokens integer optional

Maximum number of tokens to generate in the completion.

is_active boolean optional

Whether the assistant is active and available for use.

api_enabled boolean optional

Whether the assistant is accessible via API.

access_departments array optional

List of department IDs that can access this assistant.

access_users array optional

List of user IDs that can access this assistant.

allowed_model_providers array optional

List of allowed AI model providers for this assistant.

assistant_metadata object optional

Custom metadata for the assistant as key-value pairs.

context_window integer optional

Maximum context window size in tokens.

editable_by_roles array optional

List of role IDs that can edit this assistant.

editable_by_users array optional

List of user IDs that can edit this assistant.

frequency_penalty number optional

Penalty for token frequency (-2.0 to 2.0). Reduces repetition.

icon_data string optional

Base64-encoded icon image data.

icon_id string optional

ID of a predefined icon from the icon library.

icon_type string optional

Type of icon: emoji, image, or library.

instructions_thread_id string optional

Thread ID containing instruction templates.

is_default boolean optional

Whether this is the default assistant for the organization.

logit_bias object optional

Token bias adjustments as key-value pairs (token ID to bias value).

memory_enabled boolean optional

Whether the assistant can remember context across conversations.

moderation_enabled boolean optional

Whether content moderation is enabled for responses.

output_mode string optional

Output format mode: text, json, or structured.

presence_penalty number optional

Penalty for token presence (-2.0 to 2.0). Encourages topic diversity.

preset_prompts array optional

List of preset prompt IDs for quick access.

public_enabled boolean optional

Whether the assistant is publicly accessible.

reasoning object optional

Reasoning configuration for advanced models. See reasoning schema.

response_format string optional

Expected response format: text, json_object, or json_schema.

rule_ids array optional

List of rule IDs to apply to this assistant.

safety_level string optional

Content safety level: low, medium, high, or strict.

seed integer optional

Random seed for deterministic outputs.

service_tier string optional

Service tier: auto, default, or premium.

stop_sequences array optional

List of sequences where the model will stop generating.

store_responses boolean optional

Whether to store assistant responses for analytics.

streaming boolean optional

Whether to enable streaming responses.

text_config object optional

Text generation configuration options.

top_logprobs integer optional

Number of most likely tokens to return with probabilities (0-20).

top_p number optional

Nucleus sampling threshold (0.0 to 1.0).

truncation boolean optional

Whether to truncate context if it exceeds limits.

vector_store_ids array optional

List of vector store IDs for knowledge retrieval.

visible_in_chat_to_users array optional

List of user IDs who can see this assistant in chat.

visible_to_roles array optional

List of role IDs that can view this assistant.

Bash
curl https://api.aitronos.com/v1/assistants/asst_abc123 \
  -X PUT \
  -H "X-API-Key: $FREDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Assistant Name"
  }'

Response:

{
  "message": "Operation successful",
  "data": {}
}

Response

Returns

The updated Assistant object with all configuration details.

{
  "id": "asst_abc123",
  "name": "Updated Assistant Name",
  "description": "AI assistant for research and analysis",
  "model": "gpt-4o",
  "instructions": "You are a research assistant that helps find and analyze information.",
  "tools": [
    {
      "type": "web_search",
      "search_context_size": "large"
    },
    {
      "type": "code_interpreter"
    },
    {
      "type": "function",
      "name": "get_weather",
      "description": "Get current weather",
      "parameters": {
        "type": "object",
        "properties": {
          "location": {"type": "string"}
        }
      }
    }
  ],
  "access_mode": "private",
  "is_active": true,
  "temperature": 0.3,
  "max_output_synapses": 4000,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "organization_id": "org_abc123",
  "created_by": "user_abc123"
}
Previous page
Next page