Skip to main content
PATCH
Update Assistant

Path Parameters

assistant_id
string
required

Body

application/json

Request model for partially updating assistants.

Every field is optional and defaults to None so that an omitted field is distinguishable from an explicit one via model_dump(exclude_unset=True): omitting config keeps the stored config, sending {"config": {}} clears it.

A null clears description and reads as empty for the other dict fields. name and graph_id back NOT NULL columns and refuse one.

name
string

The name of the assistant. Unchanged when omitted.

description
string | null

The description of the assistant. Unchanged when omitted.

config
Config · object | null

Configuration to use for the graph. Unchanged when omitted.

graph_id
string

The ID of the graph. Unchanged when omitted.

context
Context · object | null

The context to use for the graph. Useful when graph is configurable. Unchanged when omitted.

metadata
Metadata · object | null

Metadata to merge into the assistant's existing metadata.

Response

Successful Response

Assistant entity model

assistant_id
string
required

Unique identifier for the assistant.

name
string
required

Human-readable name of the assistant.

graph_id
string
required

Identifier of the graph this assistant executes.

user_id
string
required

Identifier of the user who owns this assistant.

version
integer
required

The version of the assistant.

created_at
string<date-time>
required

Timestamp when the assistant was created.

updated_at
string<date-time>
required

Timestamp when the assistant was last updated.

description
string | null

Optional description of the assistant's purpose.

config
Config · object

Configuration passed to the graph at runtime.

context
Context · object

Context variables available to the graph during execution.

metadata_dict
Metadata Dict · object

Arbitrary metadata for searching and filtering.