Patch Assistant

Update an assistant.

PATCH /assistants/{assistant_id}

Try it

200

{
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "graph_id": "<string>",
  "config": {
    "tags": [
      "<string>"
    ],
    "recursion_limit": 123,
    "configurable": {}
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "context": {},
  "version": 123,
  "name": "<string>",
  "description": "<string>"
}

Path Parameters

assistant_id · string<uuid> · required

The ID of the assistant.

Body

application/json

Payload for updating an assistant.

graph_id · string

The ID of the graph the assistant should use. The graph ID is normally set in your langgraph.json configuration. If not provided, assistant will keep pointing to same graph.

config · Config · object

Configuration to use for the graph. Useful when graph is configurable and you want to update the assistant's configuration.

context · Context · object

Static context added to the assistant.

metadata · Metadata · object

Metadata to merge with existing assistant metadata.

name · string

The new name for the assistant. If not provided, assistant will keep its current name.

description · string

The new description for the assistant. If not provided, assistant will keep its current description.

Response

200

application/json

Success

assistant_id · string<uuid> · required

The ID of the assistant.

graph_id · string · required

The ID of the graph.

config · Config · object · required

The assistant config.

Show child attributes

config. tags · string[]

config. recursion_limit · integer

config. configurable · Configurable · object

created_at · string<date-time> · required

The time the assistant was created.

updated_at · string<date-time> · required

The last time the assistant was updated.

metadata · Metadata · object · required

The assistant metadata.

context · Context · object

Static context added to the assistant.

version · integer

The version of the assistant

name · string

The name of the assistant

description · string | null

The description of the assistant