Skip to main content
POST
/
assistants
Create Assistant
curl --request POST \
  --url https://api.example.com/assistants \
  --header 'Content-Type: application/json' \
  --data '
{
  "graph_id": "<string>",
  "assistant_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "config": {},
  "context": {},
  "metadata": {},
  "if_exists": "error"
}
'
{
  "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": {}
}

Body

application/json

Request model for creating assistants

graph_id
string
required

LangGraph graph ID from aegra.json

assistant_id
string | null

Unique assistant identifier (auto-generated if not provided)

name
string | null

Human-readable assistant name (auto-generated if not provided)

description
string | null

Assistant description

config
Config · object

Assistant configuration

context
Context · object

Assistant context

metadata
Metadata · object

Metadata to use for searching and filtering assistants.

if_exists
string | null
default:error

What to do if assistant exists: error or do_nothing

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.