Update a voice agent

Updates an existing voice agent’s details and provider configuration

PATCH /voice_agents/{id}

Update a voice agent

cURL

curl --request PATCH \
  --url https://app.kapso.ai/api/v1/voice_agents/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "voice_agent": {
    "name": "Updated Voice Agent Name",
    "provider_type": "pipecat",
    "provider": {
      "public_api_key": "pk_live_abc123",
      "private_api_key": "sk_live_xyz789",
      "agent_name": "support-agent-v2",
      "base_url": "https://api.pipecat.ai"
    }
  }
}
'

import requests

url = "https://app.kapso.ai/api/v1/voice_agents/{id}"

payload = { "voice_agent": {
        "name": "Updated Voice Agent Name",
        "provider_type": "pipecat",
        "provider": {
            "public_api_key": "pk_live_abc123",
            "private_api_key": "sk_live_xyz789",
            "agent_name": "support-agent-v2",
            "base_url": "https://api.pipecat.ai"
        }
    } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    voice_agent: {
      name: 'Updated Voice Agent Name',
      provider_type: 'pipecat',
      provider: {
        public_api_key: 'pk_live_abc123',
        private_api_key: 'sk_live_xyz789',
        agent_name: 'support-agent-v2',
        base_url: 'https://api.pipecat.ai'
      }
    }
  })
};

fetch('https://app.kapso.ai/api/v1/voice_agents/{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://app.kapso.ai/api/v1/voice_agents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'voice_agent' => [
        'name' => 'Updated Voice Agent Name',
        'provider_type' => 'pipecat',
        'provider' => [
                'public_api_key' => 'pk_live_abc123',
                'private_api_key' => 'sk_live_xyz789',
                'agent_name' => 'support-agent-v2',
                'base_url' => 'https://api.pipecat.ai'
        ]
    ]
  ]),
  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://app.kapso.ai/api/v1/voice_agents/{id}"

	payload := strings.NewReader("{\n  \"voice_agent\": {\n    \"name\": \"Updated Voice Agent Name\",\n    \"provider_type\": \"pipecat\",\n    \"provider\": {\n      \"public_api_key\": \"pk_live_abc123\",\n      \"private_api_key\": \"sk_live_xyz789\",\n      \"agent_name\": \"support-agent-v2\",\n      \"base_url\": \"https://api.pipecat.ai\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.kapso.ai/api/v1/voice_agents/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"voice_agent\": {\n    \"name\": \"Updated Voice Agent Name\",\n    \"provider_type\": \"pipecat\",\n    \"provider\": {\n      \"public_api_key\": \"pk_live_abc123\",\n      \"private_api_key\": \"sk_live_xyz789\",\n      \"agent_name\": \"support-agent-v2\",\n      \"base_url\": \"https://api.pipecat.ai\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/voice_agents/{id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"voice_agent\": {\n    \"name\": \"Updated Voice Agent Name\",\n    \"provider_type\": \"pipecat\",\n    \"provider\": {\n      \"public_api_key\": \"pk_live_abc123\",\n      \"private_api_key\": \"sk_live_xyz789\",\n      \"agent_name\": \"support-agent-v2\",\n      \"base_url\": \"https://api.pipecat.ai\"\n    }\n  }\n}"

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

200

{
  "data": {
    "id": "voice-agent-123abc",
    "name": "Customer Support Voice Agent",
    "provider": {
      "type": "pipecat_provider",
      "kind": "pipecat",
      "agent_name": "support-agent-v1"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

Authorizations

X-API-Key · string · header · required

API key required for all endpoints

Path Parameters

id · string<uuid> · required

Body

application/json

voice_agent · object · required

Show child attributes

Response

200

application/json

Voice agent updated successfully

data · object

Show child attributes