Skip to main content
PUT
/
auto
/
agent
/
{id}
Update Agent
curl --request PUT \
  --url https://api.simli.ai/auto/agent/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-simli-api-key: <api-key>' \
  --data '
{
  "face_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "first_message": "<string>",
  "prompt": "<string>",
  "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "voice_model": "sonic-english",
  "llm_model": "gpt-4o-mini",
  "llm_endpoint": "https://api.example.com/v1/chat/completions",
  "language": "<string>",
  "emotion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "max_idle_time": 123,
  "max_session_length": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://api.simli.ai/auto/agent/{id}"

payload = {
    "face_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "first_message": "<string>",
    "prompt": "<string>",
    "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "voice_model": "sonic-english",
    "llm_model": "gpt-4o-mini",
    "llm_endpoint": "https://api.example.com/v1/chat/completions",
    "language": "<string>",
    "emotion": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "max_idle_time": 123,
    "max_session_length": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
}
headers = {
    "x-simli-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {'x-simli-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    face_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    first_message: '<string>',
    prompt: '<string>',
    voice_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    voice_model: 'sonic-english',
    llm_model: 'gpt-4o-mini',
    llm_endpoint: 'https://api.example.com/v1/chat/completions',
    language: '<string>',
    emotion: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    max_idle_time: 123,
    max_session_length: 123,
    created_at: '2023-11-07T05:31:56Z',
    updated_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.simli.ai/auto/agent/{id}', 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/agent/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'face_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'first_message' => '<string>',
    'prompt' => '<string>',
    'voice_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'voice_model' => 'sonic-english',
    'llm_model' => 'gpt-4o-mini',
    'llm_endpoint' => 'https://api.example.com/v1/chat/completions',
    'language' => '<string>',
    'emotion' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'max_idle_time' => 123,
    'max_session_length' => 123,
    'created_at' => '2023-11-07T05:31:56Z',
    'updated_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.simli.ai/auto/agent/{id}"

	payload := strings.NewReader("{\n  \"face_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"first_message\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"voice_model\": \"sonic-english\",\n  \"llm_model\": \"gpt-4o-mini\",\n  \"llm_endpoint\": \"https://api.example.com/v1/chat/completions\",\n  \"language\": \"<string>\",\n  \"emotion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"max_idle_time\": 123,\n  \"max_session_length\": 123,\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-simli-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.put("https://api.simli.ai/auto/agent/{id}")
  .header("x-simli-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"face_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"first_message\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"voice_model\": \"sonic-english\",\n  \"llm_model\": \"gpt-4o-mini\",\n  \"llm_endpoint\": \"https://api.example.com/v1/chat/completions\",\n  \"language\": \"<string>\",\n  \"emotion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"max_idle_time\": 123,\n  \"max_session_length\": 123,\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.simli.ai/auto/agent/{id}")

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

request = Net::HTTP::Put.new(url)
request["x-simli-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"face_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"first_message\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"voice_model\": \"sonic-english\",\n  \"llm_model\": \"gpt-4o-mini\",\n  \"llm_endpoint\": \"https://api.example.com/v1/chat/completions\",\n  \"language\": \"<string>\",\n  \"emotion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"max_idle_time\": 123,\n  \"max_session_length\": 123,\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

Authorizations

​
x-simli-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
face_id
string<uuid>
​
name
string
​
first_message
string
​
prompt
string
​
voice_provider
enum<string>
Available options:
elevenlabs,
cartesia
​
voice_id
string<uuid>
​
voice_model
string
Example:

"sonic-english"

​
llm_model
string
Example:

"gpt-4o-mini"

​
llm_endpoint
string

The URL of the custom LLM to use

Example:

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

​
language
string
​
emotion
string<uuid>
​
max_idle_time
integer
​
max_session_length
integer
​
llm_provider
enum<string>

The provider of the LLM used by the agent

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

Timestamp when the agent was created

​
updated_at
string<date-time>

Timestamp when the agent was updated

Response

Agent updated successfully