Create agent (full)

curl --request POST \
  --url https://api.kupe.in/api/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agent": {
    "name": "Support Voice Agent",
    "first_response_message": "Hi, thanks for calling. How can I help?"
  },
  "agent_model_config": {
    "model_name": "gpt-4.1-mini",
    "system_prompt": "You are a concise billing assistant."
  },
  "transcriber_config": {
    "transcriber_model_name": "saarika:2.5",
    "language": "hi-IN"
  },
  "tts_config": {
    "tts_model_name": "bulbul:v2",
    "language": "hi-IN",
    "voice_name": "Anushka"
  },
  "agent_specific_config": {
    "session_timeout": 300,
    "auto_terminate_call": true,
    "llm_conversation_stop_enabled": true,
    "timezone": "Asia/Kolkata"
  }
}
'

import requests

url = "https://api.kupe.in/api/v1/agents"

payload = {
    "agent": {
        "name": "Support Voice Agent",
        "first_response_message": "Hi, thanks for calling. How can I help?"
    },
    "agent_model_config": {
        "model_name": "gpt-4.1-mini",
        "system_prompt": "You are a concise billing assistant."
    },
    "transcriber_config": {
        "transcriber_model_name": "saarika:2.5",
        "language": "hi-IN"
    },
    "tts_config": {
        "tts_model_name": "bulbul:v2",
        "language": "hi-IN",
        "voice_name": "Anushka"
    },
    "agent_specific_config": {
        "session_timeout": 300,
        "auto_terminate_call": True,
        "llm_conversation_stop_enabled": True,
        "timezone": "Asia/Kolkata"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent: {
      name: 'Support Voice Agent',
      first_response_message: 'Hi, thanks for calling. How can I help?'
    },
    agent_model_config: {
      model_name: 'gpt-4.1-mini',
      system_prompt: 'You are a concise billing assistant.'
    },
    transcriber_config: {transcriber_model_name: 'saarika:2.5', language: 'hi-IN'},
    tts_config: {tts_model_name: 'bulbul:v2', language: 'hi-IN', voice_name: 'Anushka'},
    agent_specific_config: {
      session_timeout: 300,
      auto_terminate_call: true,
      llm_conversation_stop_enabled: true,
      timezone: 'Asia/Kolkata'
    }
  })
};

fetch('https://api.kupe.in/api/v1/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.kupe.in/api/v1/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'agent' => [
        'name' => 'Support Voice Agent',
        'first_response_message' => 'Hi, thanks for calling. How can I help?'
    ],
    'agent_model_config' => [
        'model_name' => 'gpt-4.1-mini',
        'system_prompt' => 'You are a concise billing assistant.'
    ],
    'transcriber_config' => [
        'transcriber_model_name' => 'saarika:2.5',
        'language' => 'hi-IN'
    ],
    'tts_config' => [
        'tts_model_name' => 'bulbul:v2',
        'language' => 'hi-IN',
        'voice_name' => 'Anushka'
    ],
    'agent_specific_config' => [
        'session_timeout' => 300,
        'auto_terminate_call' => true,
        'llm_conversation_stop_enabled' => true,
        'timezone' => 'Asia/Kolkata'
    ]
  ]),
  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://api.kupe.in/api/v1/agents"

	payload := strings.NewReader("{\n  \"agent\": {\n    \"name\": \"Support Voice Agent\",\n    \"first_response_message\": \"Hi, thanks for calling. How can I help?\"\n  },\n  \"agent_model_config\": {\n    \"model_name\": \"gpt-4.1-mini\",\n    \"system_prompt\": \"You are a concise billing assistant.\"\n  },\n  \"transcriber_config\": {\n    \"transcriber_model_name\": \"saarika:2.5\",\n    \"language\": \"hi-IN\"\n  },\n  \"tts_config\": {\n    \"tts_model_name\": \"bulbul:v2\",\n    \"language\": \"hi-IN\",\n    \"voice_name\": \"Anushka\"\n  },\n  \"agent_specific_config\": {\n    \"session_timeout\": 300,\n    \"auto_terminate_call\": true,\n    \"llm_conversation_stop_enabled\": true,\n    \"timezone\": \"Asia/Kolkata\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.kupe.in/api/v1/agents")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent\": {\n    \"name\": \"Support Voice Agent\",\n    \"first_response_message\": \"Hi, thanks for calling. How can I help?\"\n  },\n  \"agent_model_config\": {\n    \"model_name\": \"gpt-4.1-mini\",\n    \"system_prompt\": \"You are a concise billing assistant.\"\n  },\n  \"transcriber_config\": {\n    \"transcriber_model_name\": \"saarika:2.5\",\n    \"language\": \"hi-IN\"\n  },\n  \"tts_config\": {\n    \"tts_model_name\": \"bulbul:v2\",\n    \"language\": \"hi-IN\",\n    \"voice_name\": \"Anushka\"\n  },\n  \"agent_specific_config\": {\n    \"session_timeout\": 300,\n    \"auto_terminate_call\": true,\n    \"llm_conversation_stop_enabled\": true,\n    \"timezone\": \"Asia/Kolkata\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kupe.in/api/v1/agents")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent\": {\n    \"name\": \"Support Voice Agent\",\n    \"first_response_message\": \"Hi, thanks for calling. How can I help?\"\n  },\n  \"agent_model_config\": {\n    \"model_name\": \"gpt-4.1-mini\",\n    \"system_prompt\": \"You are a concise billing assistant.\"\n  },\n  \"transcriber_config\": {\n    \"transcriber_model_name\": \"saarika:2.5\",\n    \"language\": \"hi-IN\"\n  },\n  \"tts_config\": {\n    \"tts_model_name\": \"bulbul:v2\",\n    \"language\": \"hi-IN\",\n    \"voice_name\": \"Anushka\"\n  },\n  \"agent_specific_config\": {\n    \"session_timeout\": 300,\n    \"auto_terminate_call\": true,\n    \"llm_conversation_stop_enabled\": true,\n    \"timezone\": \"Asia/Kolkata\"\n  }\n}"

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

{
  "agent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_active": true
  },
  "configurations": {},
  "validation_status": "valid"
}

{
  "detail": "Forbidden: API Key does not have required scopes"
}

{
  "detail": "Forbidden: API Key does not have required scopes"
}

{
  "detail": "Forbidden: API Key does not have required scopes"
}

{
  "detail": "Forbidden: API Key does not have required scopes"
}

Agent Management

Create agent (full)

Full URL: POST https://api.kupe.in/api/v1/agents

Create an agent and its configurations in one request (LLM, STT, TTS, optional tools, and agent_specific_config). Platform defaults apply for any omitted section (including VAD / inferencing). For a name-only create with all defaults, use POST /api/v1/agents/simple instead.

agent_specific_config is optional on create; send only the behavior keys you need (timeouts, auto_terminate_call, inbound transfer routes, end-call warnings, noise cancellation strength, background noise, etc.). Omitted keys use platform defaults. List background noise files with GET /api/v1/noise-assets before setting background_noise_id.

POST

api

agents

Create agent (full)

curl --request POST \
  --url https://api.kupe.in/api/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agent": {
    "name": "Support Voice Agent",
    "first_response_message": "Hi, thanks for calling. How can I help?"
  },
  "agent_model_config": {
    "model_name": "gpt-4.1-mini",
    "system_prompt": "You are a concise billing assistant."
  },
  "transcriber_config": {
    "transcriber_model_name": "saarika:2.5",
    "language": "hi-IN"
  },
  "tts_config": {
    "tts_model_name": "bulbul:v2",
    "language": "hi-IN",
    "voice_name": "Anushka"
  },
  "agent_specific_config": {
    "session_timeout": 300,
    "auto_terminate_call": true,
    "llm_conversation_stop_enabled": true,
    "timezone": "Asia/Kolkata"
  }
}
'

import requests

url = "https://api.kupe.in/api/v1/agents"

payload = {
    "agent": {
        "name": "Support Voice Agent",
        "first_response_message": "Hi, thanks for calling. How can I help?"
    },
    "agent_model_config": {
        "model_name": "gpt-4.1-mini",
        "system_prompt": "You are a concise billing assistant."
    },
    "transcriber_config": {
        "transcriber_model_name": "saarika:2.5",
        "language": "hi-IN"
    },
    "tts_config": {
        "tts_model_name": "bulbul:v2",
        "language": "hi-IN",
        "voice_name": "Anushka"
    },
    "agent_specific_config": {
        "session_timeout": 300,
        "auto_terminate_call": True,
        "llm_conversation_stop_enabled": True,
        "timezone": "Asia/Kolkata"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent: {
      name: 'Support Voice Agent',
      first_response_message: 'Hi, thanks for calling. How can I help?'
    },
    agent_model_config: {
      model_name: 'gpt-4.1-mini',
      system_prompt: 'You are a concise billing assistant.'
    },
    transcriber_config: {transcriber_model_name: 'saarika:2.5', language: 'hi-IN'},
    tts_config: {tts_model_name: 'bulbul:v2', language: 'hi-IN', voice_name: 'Anushka'},
    agent_specific_config: {
      session_timeout: 300,
      auto_terminate_call: true,
      llm_conversation_stop_enabled: true,
      timezone: 'Asia/Kolkata'
    }
  })
};

fetch('https://api.kupe.in/api/v1/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.kupe.in/api/v1/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'agent' => [
        'name' => 'Support Voice Agent',
        'first_response_message' => 'Hi, thanks for calling. How can I help?'
    ],
    'agent_model_config' => [
        'model_name' => 'gpt-4.1-mini',
        'system_prompt' => 'You are a concise billing assistant.'
    ],
    'transcriber_config' => [
        'transcriber_model_name' => 'saarika:2.5',
        'language' => 'hi-IN'
    ],
    'tts_config' => [
        'tts_model_name' => 'bulbul:v2',
        'language' => 'hi-IN',
        'voice_name' => 'Anushka'
    ],
    'agent_specific_config' => [
        'session_timeout' => 300,
        'auto_terminate_call' => true,
        'llm_conversation_stop_enabled' => true,
        'timezone' => 'Asia/Kolkata'
    ]
  ]),
  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://api.kupe.in/api/v1/agents"

	payload := strings.NewReader("{\n  \"agent\": {\n    \"name\": \"Support Voice Agent\",\n    \"first_response_message\": \"Hi, thanks for calling. How can I help?\"\n  },\n  \"agent_model_config\": {\n    \"model_name\": \"gpt-4.1-mini\",\n    \"system_prompt\": \"You are a concise billing assistant.\"\n  },\n  \"transcriber_config\": {\n    \"transcriber_model_name\": \"saarika:2.5\",\n    \"language\": \"hi-IN\"\n  },\n  \"tts_config\": {\n    \"tts_model_name\": \"bulbul:v2\",\n    \"language\": \"hi-IN\",\n    \"voice_name\": \"Anushka\"\n  },\n  \"agent_specific_config\": {\n    \"session_timeout\": 300,\n    \"auto_terminate_call\": true,\n    \"llm_conversation_stop_enabled\": true,\n    \"timezone\": \"Asia/Kolkata\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.kupe.in/api/v1/agents")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent\": {\n    \"name\": \"Support Voice Agent\",\n    \"first_response_message\": \"Hi, thanks for calling. How can I help?\"\n  },\n  \"agent_model_config\": {\n    \"model_name\": \"gpt-4.1-mini\",\n    \"system_prompt\": \"You are a concise billing assistant.\"\n  },\n  \"transcriber_config\": {\n    \"transcriber_model_name\": \"saarika:2.5\",\n    \"language\": \"hi-IN\"\n  },\n  \"tts_config\": {\n    \"tts_model_name\": \"bulbul:v2\",\n    \"language\": \"hi-IN\",\n    \"voice_name\": \"Anushka\"\n  },\n  \"agent_specific_config\": {\n    \"session_timeout\": 300,\n    \"auto_terminate_call\": true,\n    \"llm_conversation_stop_enabled\": true,\n    \"timezone\": \"Asia/Kolkata\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kupe.in/api/v1/agents")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent\": {\n    \"name\": \"Support Voice Agent\",\n    \"first_response_message\": \"Hi, thanks for calling. How can I help?\"\n  },\n  \"agent_model_config\": {\n    \"model_name\": \"gpt-4.1-mini\",\n    \"system_prompt\": \"You are a concise billing assistant.\"\n  },\n  \"transcriber_config\": {\n    \"transcriber_model_name\": \"saarika:2.5\",\n    \"language\": \"hi-IN\"\n  },\n  \"tts_config\": {\n    \"tts_model_name\": \"bulbul:v2\",\n    \"language\": \"hi-IN\",\n    \"voice_name\": \"Anushka\"\n  },\n  \"agent_specific_config\": {\n    \"session_timeout\": 300,\n    \"auto_terminate_call\": true,\n    \"llm_conversation_stop_enabled\": true,\n    \"timezone\": \"Asia/Kolkata\"\n  }\n}"

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

{
  "agent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_active": true
  },
  "configurations": {},
  "validation_status": "valid"
}

{
  "detail": "Forbidden: API Key does not have required scopes"
}

{
  "detail": "Forbidden: API Key does not have required scopes"
}

{
  "detail": "Forbidden: API Key does not have required scopes"
}

{
  "detail": "Forbidden: API Key does not have required scopes"
}

Authorizations

x-api-key

string

header

default:YOUR_KUPE_API_KEY

required

Kupe dashboard API key for your user.

Body

application/json

Body for POST /api/v1/agents (full create). Requires agent.name; all other top-level keys are optional. Set runtime behavior (timeouts, auto hangup, inbound transfer routes, audio tuning) under agent_specific_config — values are merged onto platform defaults and stored in agent_specific_configs.configuration (separate from share/branding info). Enable inbound noise reduction on agent.apply_noise_reduction. Welcome line: agent.first_response_message or agent.welcome_message (alias). Not used for POST /api/v1/agents/simple.

agent

object

required

Show child attributes

agent_model_config

object

model_name: LLM catalog code or row UUID. Requests may also send the legacy property model_provider_id with the same meaning (OpenAPI lists one field to avoid duplicate inputs).

Show child attributes

tts_config

object

tts_model_name selects the TTS row (catalog code or UUID). Optional language sets voice_parameters.language (e.g. en, hi-IN). Legacy body key tts_provider_id is accepted as an alias for tts_model_name only (not listed as a second field).

Show child attributes

transcriber_config

object

transcriber_model_name selects the STT row (catalog code or UUID, e.g. saarika:2.5). language is a locale string (e.g. hi-IN); a single-element array ["hi-IN"] is coerced to that string. The pipeline STT model id is derived from the catalog row only — it is not sent in this object. Legacy provider_id is an alias for transcriber_model_name.

Show child attributes

agent_specific_config

object

Per-agent behavior stored in agent_specific_configs.configuration. On create (POST /api/v1/agents) and update (PUT /api/v1/agents/{agent_id}), send under agent_specific_config; omitted keys keep platform or existing values (partial PUT merges). Returned on GET /api/v1/agents/{agent_id} under configurations.agent_specific_config. Dashboard may use camelCase aliases (e.g. autoTerminate → auto_terminate_call).

Show child attributes

Response

Created — returns CreateAgentResponse (agent.id is agent_id)

Complete agent response (abridged).

agent

object

Show child attributes

configurations

object

validation_status

string

Example:

"valid"

Overview

Campaigns & Contacts

Voice Agent API

Create agent (full)

Authorizations

Body

Response