Update Assistant

Update an assistant by its ID.

Partial update: only fields included in the request body are changed. Creates a new version of the assistant.

PATCH /assistants/{assistant_id}

Update Assistant

cURL

curl --request PATCH \
  --url https://api.example.com/assistants/{assistant_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "config": {},
  "graph_id": "agent",
  "context": {},
  "metadata": {}
}
'

200

{
  "assistant_id": "<string>",
  "name": "<string>",
  "graph_id": "<string>",
  "user_id": "<string>",
  "version": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "config": {},
  "context": {},
  "metadata_dict": {}
}

Path Parameters

assistant_id · string · required

Body

application/json

Request model for creating assistants

name · string | null

The name of the assistant (auto-generated if not provided)

description · string | null

The description of the assistant. Defaults to null.

config · Config · object

Configuration to use for the graph.

graph_id · string · default: agent

The ID of the graph

context · Context · object

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

metadata · Metadata · object

Metadata to use for searching and filtering assistants.

Response

200

application/json

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.