GET
/
agents
curl --request GET \
  --url https://api.simli.ai/agents \
  --header 'x-simli-api-key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "face_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Untitled Agent",
    "first_message": "<string>",
    "prompt": "<string>",
    "voice_provider": "elevenlabs",
    "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "voice_model": "sonic-english",
    "language": "<string>",
    "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"
  }
]

Authorizations

​
x-simli-api-key
string
header
required

API key for authentication

Response

200 - application/json
List of agents
​
id
string
required

Unique identifier for the agent, generated by the MySQL service

​
face_id
string
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
required
​
voice_model
string
required
Example:

"sonic-english"

​
language
string
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

​
created_at
string
required

Timestamp when the agent was created

​
updated_at
string
required

Timestamp when the agent was last updated

Suggest edits