Skip to main content
GET
/
auto
/
agents
Get All Agents
curl --request GET \
  --url https://api.simli.ai/auto/agents \
  --header 'x-simli-api-key: <api-key>'
import requests

url = "https://api.simli.ai/auto/agents"

headers = {"x-simli-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-simli-api-key': '<api-key>'}};

fetch('https://api.simli.ai/auto/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_URL => "https://api.simli.ai/auto/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-simli-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"
"net/http"
"io"
)

func main() {

url := "https://api.simli.ai/auto/agents"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-simli-api-key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.simli.ai/auto/agents")
.header("x-simli-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.simli.ai/auto/agents")

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

request = Net::HTTP::Get.new(url)
request["x-simli-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "face_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Untitled Agent",
    "first_message": "<string>",
    "prompt": "<string>",
    "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "voice_model": "sonic-english",
    "language": "<string>",
    "emotion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "llm_model": "gpt-4o-mini",
    "llm_endpoint": "https://api.example.com/v1/chat/completions",
    "max_idle_time": 300,
    "max_session_length": 3600,
    "owner_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "simli_version": 1
  }
]

Authorizations

x-simli-api-key
string
header
required

Response

200 - application/json

List of agents

id
string<uuid>
required

Unique identifier for the agent, generated by the MySQL service

face_id
string<uuid>
required
name
string
default:Untitled Agent
required
first_message
string
required
prompt
string
required
voice_provider
enum<string>
required
Available options:
elevenlabs,
cartesia
voice_id
string<uuid>
required
voice_model
string
required
Example:

"sonic-english"

language
string
required
emotion
string<uuid>
required
llm_model
string
required
Example:

"gpt-4o-mini"

llm_endpoint
string
required

The URL of the custom LLM to use

Example:

"https://api.example.com/v1/chat/completions"

max_idle_time
integer
default:300
required
max_session_length
integer
default:3600
required
owner_id
string
required

Unique identifier for the owner of the agent

llm_provider
enum<string>
required

The provider of the LLM used by the agent

Available options:
openai,
google,
user
created_at
string<date-time>
required

Timestamp when the agent was created

updated_at
string<date-time>
required

Timestamp when the agent was last updated

simli_version
integer

Version of the Simli model used for the face

Example:

1