Start an Equos avatar sesssion.
curl --request POST \
--url https://api.equos.ai/v3/conversations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"characterId": "<string>",
"client": "<string>",
"host": {
"serverUrl": "<string>",
"accessToken": "<string>"
},
"remoteAgent": {
"identity": "<string>",
"name": "<string>"
},
"consumer": {
"identity": "<string>",
"name": "<string>"
},
"maxSeconds": 123,
"promptCtx": "<string>",
"promptTemplateVars": {}
}
'import requests
url = "https://api.equos.ai/v3/conversations"
payload = {
"name": "<string>",
"characterId": "<string>",
"client": "<string>",
"host": {
"serverUrl": "<string>",
"accessToken": "<string>"
},
"remoteAgent": {
"identity": "<string>",
"name": "<string>"
},
"consumer": {
"identity": "<string>",
"name": "<string>"
},
"maxSeconds": 123,
"promptCtx": "<string>",
"promptTemplateVars": {}
}
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>',
characterId: '<string>',
client: '<string>',
host: {serverUrl: '<string>', accessToken: '<string>'},
remoteAgent: {identity: '<string>', name: '<string>'},
consumer: {identity: '<string>', name: '<string>'},
maxSeconds: 123,
promptCtx: '<string>',
promptTemplateVars: {}
})
};
fetch('https://api.equos.ai/v3/conversations', 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/conversations",
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>',
'characterId' => '<string>',
'client' => '<string>',
'host' => [
'serverUrl' => '<string>',
'accessToken' => '<string>'
],
'remoteAgent' => [
'identity' => '<string>',
'name' => '<string>'
],
'consumer' => [
'identity' => '<string>',
'name' => '<string>'
],
'maxSeconds' => 123,
'promptCtx' => '<string>',
'promptTemplateVars' => [
]
]),
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/conversations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"characterId\": \"<string>\",\n \"client\": \"<string>\",\n \"host\": {\n \"serverUrl\": \"<string>\",\n \"accessToken\": \"<string>\"\n },\n \"remoteAgent\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"consumer\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"maxSeconds\": 123,\n \"promptCtx\": \"<string>\",\n \"promptTemplateVars\": {}\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/conversations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"characterId\": \"<string>\",\n \"client\": \"<string>\",\n \"host\": {\n \"serverUrl\": \"<string>\",\n \"accessToken\": \"<string>\"\n },\n \"remoteAgent\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"consumer\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"maxSeconds\": 123,\n \"promptCtx\": \"<string>\",\n \"promptTemplateVars\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.equos.ai/v3/conversations")
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 \"characterId\": \"<string>\",\n \"client\": \"<string>\",\n \"host\": {\n \"serverUrl\": \"<string>\",\n \"accessToken\": \"<string>\"\n },\n \"remoteAgent\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"consumer\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"maxSeconds\": 123,\n \"promptCtx\": \"<string>\",\n \"promptTemplateVars\": {}\n}"
response = http.request(request)
puts response.read_body{
"conversation": {
"id": "<string>",
"name": "<string>",
"charge": true,
"chargeBySecond": 123,
"maxSeconds": 123,
"startedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"characterId": "<string>",
"organizationId": "<string>",
"character": {
"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>"
}
},
"client": "<string>",
"room": "<string>",
"serverUrl": "<string>",
"remoteAgentName": "<string>",
"remoteAgentIdentity": "<string>",
"consumerName": "<string>",
"consumerIdentity": "<string>",
"promptCtx": "<string>",
"promptTemplateVars": {},
"transcript": [
{
"id": "<string>",
"content": "<string>",
"recordedAt": "2023-11-07T05:31:56Z"
}
],
"timeline": [
{
"type": "<string>",
"recordedAt": "<string>",
"author": "<string>",
"content": "<string>"
}
],
"joinedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z"
},
"remoteAgentAccessToken": "<string>",
"consumerAccessToken": "<string>"
}Conversation
Start an Equos avatar sesssion.
POST
/
v3
/
conversations
Start an Equos avatar sesssion.
curl --request POST \
--url https://api.equos.ai/v3/conversations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"characterId": "<string>",
"client": "<string>",
"host": {
"serverUrl": "<string>",
"accessToken": "<string>"
},
"remoteAgent": {
"identity": "<string>",
"name": "<string>"
},
"consumer": {
"identity": "<string>",
"name": "<string>"
},
"maxSeconds": 123,
"promptCtx": "<string>",
"promptTemplateVars": {}
}
'import requests
url = "https://api.equos.ai/v3/conversations"
payload = {
"name": "<string>",
"characterId": "<string>",
"client": "<string>",
"host": {
"serverUrl": "<string>",
"accessToken": "<string>"
},
"remoteAgent": {
"identity": "<string>",
"name": "<string>"
},
"consumer": {
"identity": "<string>",
"name": "<string>"
},
"maxSeconds": 123,
"promptCtx": "<string>",
"promptTemplateVars": {}
}
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>',
characterId: '<string>',
client: '<string>',
host: {serverUrl: '<string>', accessToken: '<string>'},
remoteAgent: {identity: '<string>', name: '<string>'},
consumer: {identity: '<string>', name: '<string>'},
maxSeconds: 123,
promptCtx: '<string>',
promptTemplateVars: {}
})
};
fetch('https://api.equos.ai/v3/conversations', 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/conversations",
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>',
'characterId' => '<string>',
'client' => '<string>',
'host' => [
'serverUrl' => '<string>',
'accessToken' => '<string>'
],
'remoteAgent' => [
'identity' => '<string>',
'name' => '<string>'
],
'consumer' => [
'identity' => '<string>',
'name' => '<string>'
],
'maxSeconds' => 123,
'promptCtx' => '<string>',
'promptTemplateVars' => [
]
]),
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/conversations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"characterId\": \"<string>\",\n \"client\": \"<string>\",\n \"host\": {\n \"serverUrl\": \"<string>\",\n \"accessToken\": \"<string>\"\n },\n \"remoteAgent\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"consumer\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"maxSeconds\": 123,\n \"promptCtx\": \"<string>\",\n \"promptTemplateVars\": {}\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/conversations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"characterId\": \"<string>\",\n \"client\": \"<string>\",\n \"host\": {\n \"serverUrl\": \"<string>\",\n \"accessToken\": \"<string>\"\n },\n \"remoteAgent\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"consumer\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"maxSeconds\": 123,\n \"promptCtx\": \"<string>\",\n \"promptTemplateVars\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.equos.ai/v3/conversations")
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 \"characterId\": \"<string>\",\n \"client\": \"<string>\",\n \"host\": {\n \"serverUrl\": \"<string>\",\n \"accessToken\": \"<string>\"\n },\n \"remoteAgent\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"consumer\": {\n \"identity\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"maxSeconds\": 123,\n \"promptCtx\": \"<string>\",\n \"promptTemplateVars\": {}\n}"
response = http.request(request)
puts response.read_body{
"conversation": {
"id": "<string>",
"name": "<string>",
"charge": true,
"chargeBySecond": 123,
"maxSeconds": 123,
"startedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"characterId": "<string>",
"organizationId": "<string>",
"character": {
"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>"
}
},
"client": "<string>",
"room": "<string>",
"serverUrl": "<string>",
"remoteAgentName": "<string>",
"remoteAgentIdentity": "<string>",
"consumerName": "<string>",
"consumerIdentity": "<string>",
"promptCtx": "<string>",
"promptTemplateVars": {},
"transcript": [
{
"id": "<string>",
"content": "<string>",
"recordedAt": "2023-11-07T05:31:56Z"
}
],
"timeline": [
{
"type": "<string>",
"recordedAt": "<string>",
"author": "<string>",
"content": "<string>"
}
],
"joinedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z"
},
"remoteAgentAccessToken": "<string>",
"consumerAccessToken": "<string>"
}Authorizations
Body
application/json
List Equos conversations.Stop a conversation. Returns null if already stopped or conversation was not found.
⌘I