Skip to main content
POST
/
api
/
agents
Create a new agent
curl --request POST \
  --url http://localhost:3000/api/agents \
  --header 'Content-Type: application/json' \
  --data '
{
  "characterPath": "<string>",
  "characterJson": {}
}
'
import requests

url = "http://localhost:3000/api/agents"

payload = {
    "characterPath": "<string>",
    "characterJson": {}
}
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({characterPath: '<string>', characterJson: {}})
};

fetch('http://localhost:3000/api/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/agents",
  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([
    'characterPath' => '<string>',
    'characterJson' => [
        
    ]
  ]),
  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 := "http://localhost:3000/api/agents"

	payload := strings.NewReader("{\n  \"characterPath\": \"<string>\",\n  \"characterJson\": {}\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("http://localhost:3000/api/agents")
  .header("Content-Type", "application/json")
  .body("{\n  \"characterPath\": \"<string>\",\n  \"characterJson\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/agents")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"characterPath\": \"<string>\",\n  \"characterJson\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "character": {
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bio": "<string>",
      "settings": {},
      "system": "<string>",
      "style": {},
      "lore": [
        "<string>"
      ],
      "messageExamples": [
        "<string>"
      ],
      "topics": [
        "<string>"
      ],
      "plugins": [
        "<string>"
      ]
    }
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}

Body

application/json
​
characterPath
string

Path to a character file

​
characterJson
object

Character configuration in JSON format

Response

Agent created successfully

​
success
boolean
Example:

true

​
data
object