Simli Auto
Face ID Creation
WebRTC API
Get Agent
Get details of a specific agent
GET
/
agent
/
{id}
curl --request GET \
--url https://api.simli.ai/agent/{id} \
--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
API key for authentication
Path Parameters
Response
200 - application/json
A single agent
The response is of type object
.
curl --request GET \
--url https://api.simli.ai/agent/{id} \
--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"
}