Create a new Equos Character.
curl --request POST \
--url https://api.equos.ai/v3/characters \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"livekitIdentity": "<string>",
"client": "<string>",
"faceId": "<string>",
"voiceId": "<string>",
"brainId": "<string>",
"knowledgeBaseId": "<string>",
"search": false,
"elevenlabsAgentId": "<string>"
}
'import requests
url = "https://api.equos.ai/v3/characters"
payload = {
"name": "<string>",
"livekitIdentity": "<string>",
"client": "<string>",
"faceId": "<string>",
"voiceId": "<string>",
"brainId": "<string>",
"knowledgeBaseId": "<string>",
"search": False,
"elevenlabsAgentId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
livekitIdentity: '<string>',
client: '<string>',
faceId: '<string>',
voiceId: '<string>',
brainId: '<string>',
knowledgeBaseId: '<string>',
search: false,
elevenlabsAgentId: '<string>'
})
};
fetch('https://api.equos.ai/v3/characters', 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.equos.ai/v3/characters",
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([
'name' => '<string>',
'livekitIdentity' => '<string>',
'client' => '<string>',
'faceId' => '<string>',
'voiceId' => '<string>',
'brainId' => '<string>',
'knowledgeBaseId' => '<string>',
'search' => false,
'elevenlabsAgentId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.equos.ai/v3/characters"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"livekitIdentity\": \"<string>\",\n \"client\": \"<string>\",\n \"faceId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"brainId\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"search\": false,\n \"elevenlabsAgentId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.equos.ai/v3/characters")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"livekitIdentity\": \"<string>\",\n \"client\": \"<string>\",\n \"faceId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"brainId\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"search\": false,\n \"elevenlabsAgentId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.equos.ai/v3/characters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"livekitIdentity\": \"<string>\",\n \"client\": \"<string>\",\n \"faceId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"brainId\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"search\": false,\n \"elevenlabsAgentId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"livekitIdentity": "<string>",
"search": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>",
"elevenlabsAgentId": "<string>",
"faceId": "<string>",
"voiceId": "<string>",
"brainId": "<string>",
"knowledgeBaseId": "<string>",
"face": {
"id": "<string>",
"identity": "tommy",
"organizationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>",
"description": "<string>",
"thumbnailUrl": "<string>",
"referenceImgUrl": "<string>"
},
"voice": {
"id": "<string>",
"organizationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>",
"instructions": "<string>"
},
"brain": {
"id": "<string>",
"organizationId": "<string>",
"instructions": "<string>",
"greetingMessage": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>"
},
"knowledgeBase": {
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"description": "<string>",
"documents": [
{
"id": "<string>",
"knowledgeBaseId": "<string>",
"name": "<string>",
"description": "<string>",
"size": 123,
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>"
}
}Character
Create a new Equos Character.
POST
/
v3
/
characters
Create a new Equos Character.
curl --request POST \
--url https://api.equos.ai/v3/characters \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"livekitIdentity": "<string>",
"client": "<string>",
"faceId": "<string>",
"voiceId": "<string>",
"brainId": "<string>",
"knowledgeBaseId": "<string>",
"search": false,
"elevenlabsAgentId": "<string>"
}
'import requests
url = "https://api.equos.ai/v3/characters"
payload = {
"name": "<string>",
"livekitIdentity": "<string>",
"client": "<string>",
"faceId": "<string>",
"voiceId": "<string>",
"brainId": "<string>",
"knowledgeBaseId": "<string>",
"search": False,
"elevenlabsAgentId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
livekitIdentity: '<string>',
client: '<string>',
faceId: '<string>',
voiceId: '<string>',
brainId: '<string>',
knowledgeBaseId: '<string>',
search: false,
elevenlabsAgentId: '<string>'
})
};
fetch('https://api.equos.ai/v3/characters', 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.equos.ai/v3/characters",
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([
'name' => '<string>',
'livekitIdentity' => '<string>',
'client' => '<string>',
'faceId' => '<string>',
'voiceId' => '<string>',
'brainId' => '<string>',
'knowledgeBaseId' => '<string>',
'search' => false,
'elevenlabsAgentId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.equos.ai/v3/characters"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"livekitIdentity\": \"<string>\",\n \"client\": \"<string>\",\n \"faceId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"brainId\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"search\": false,\n \"elevenlabsAgentId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.equos.ai/v3/characters")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"livekitIdentity\": \"<string>\",\n \"client\": \"<string>\",\n \"faceId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"brainId\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"search\": false,\n \"elevenlabsAgentId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.equos.ai/v3/characters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"livekitIdentity\": \"<string>\",\n \"client\": \"<string>\",\n \"faceId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"brainId\": \"<string>\",\n \"knowledgeBaseId\": \"<string>\",\n \"search\": false,\n \"elevenlabsAgentId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"livekitIdentity": "<string>",
"search": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>",
"elevenlabsAgentId": "<string>",
"faceId": "<string>",
"voiceId": "<string>",
"brainId": "<string>",
"knowledgeBaseId": "<string>",
"face": {
"id": "<string>",
"identity": "tommy",
"organizationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>",
"description": "<string>",
"thumbnailUrl": "<string>",
"referenceImgUrl": "<string>"
},
"voice": {
"id": "<string>",
"organizationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>",
"instructions": "<string>"
},
"brain": {
"id": "<string>",
"organizationId": "<string>",
"instructions": "<string>",
"greetingMessage": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>"
},
"knowledgeBase": {
"id": "<string>",
"organizationId": "<string>",
"name": "<string>",
"description": "<string>",
"documents": [
{
"id": "<string>",
"knowledgeBaseId": "<string>",
"name": "<string>",
"description": "<string>",
"size": 123,
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"client": "<string>"
}
}Authorizations
Body
application/json
Client identifier associated with the character. This is useful to segment resources by client.
Response
201 - application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I