Get Assistant

Get an assistant by ID.

GET /assistants/{assistant_id}

Get Assistant

cURL

curl --request GET \
  --url https://api.example.com/assistants/{assistant_id}

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.

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

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