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"
}
'
import requests

url = "https://api.example.com/assistants"

payload = {
"graph_id": "<string>",
"assistant_id": "<string>",
"name": "<string>",
"description": "<string>",
"config": {},
"context": {},
"metadata": {},
"if_exists": "error"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
graph_id: '<string>',
assistant_id: '<string>',
name: '<string>',
description: '<string>',
config: {},
context: {},
metadata: {},
if_exists: 'error'
})
};

fetch('https://api.example.com/assistants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/assistants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'graph_id' => '<string>',
'assistant_id' => '<string>',
'name' => '<string>',
'description' => '<string>',
'config' => [

],
'context' => [

],
'metadata' => [

],
'if_exists' => 'error'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/assistants"

payload := strings.NewReader("{\n \"graph_id\": \"<string>\",\n \"assistant_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {},\n \"context\": {},\n \"metadata\": {},\n \"if_exists\": \"error\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/assistants")
.header("Content-Type", "application/json")
.body("{\n \"graph_id\": \"<string>\",\n \"assistant_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {},\n \"context\": {},\n \"metadata\": {},\n \"if_exists\": \"error\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/assistants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"graph_id\": \"<string>\",\n \"assistant_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {},\n \"context\": {},\n \"metadata\": {},\n \"if_exists\": \"error\"\n}"

response = http.request(request)
puts response.read_body
{
  "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": {}
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

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 | null

Assistant configuration

context
Context · object | null

Assistant context

metadata
Metadata · object | null

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.