Skip to main content
POST
/
agents
/
{agent_id}
/
duplicate
Duplicate an agent
curl --request POST \
  --url https://api.coval.dev/v1/agents/{agent_id}/duplicate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "include_associations": true
}
'
import requests

url = "https://api.coval.dev/v1/agents/{agent_id}/duplicate"

payload = { "include_associations": True }
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({include_associations: true})
};

fetch('https://api.coval.dev/v1/agents/{agent_id}/duplicate', 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.coval.dev/v1/agents/{agent_id}/duplicate",
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([
'include_associations' => true
]),
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.coval.dev/v1/agents/{agent_id}/duplicate"

payload := strings.NewReader("{\n \"include_associations\": true\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.coval.dev/v1/agents/{agent_id}/duplicate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"include_associations\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.coval.dev/v1/agents/{agent_id}/duplicate")

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 \"include_associations\": true\n}"

response = http.request(request)
puts response.read_body
{
  "agent": {
    "customer_agent_id": "my-support-agent",
    "id": "abc123def456ghi789jklm",
    "display_name": "Customer Support Agent",
    "model_type": "MODEL_TYPE_VOICE",
    "phone_number": "+1234567890",
    "endpoint": "https://api.example.com/agent",
    "prompt": "You are a helpful customer support agent...",
    "language": "en",
    "attributes": {
      "company_name": "Acme Corp",
      "tier": "enterprise"
    },
    "metadata": {
      "voice": "alloy",
      "model": "gpt-realtime-2"
    },
    "workflows": {},
    "metric_ids": [
      "abc123def456ghi789jklm",
      "def456ghi789jklmabc123"
    ],
    "test_set_ids": [
      "gT5wq2Hn"
    ],
    "knowledge_base_ids": [],
    "tags": [
      "production",
      "voice"
    ],
    "create_time": "2025-10-14T12:00:00Z",
    "update_time": "2025-10-15T14:30:00Z"
  }
}
{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid request parameter",
"details": [
{
"field": "page_size",
"description": "page_size must be between 1 and 100"
}
]
}
}
{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "x-api-key",
"description": "Invalid or missing API key"
}
]
}
}
{
"error": {
"code": "NOT_FOUND",
"message": "Agent not found",
"details": [
{
"field": "agent_id",
"description": "Agent not found or not accessible by your organization"
}
]
}
}
{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

agent_id
string
required

ID of the agent to duplicate

Pattern: ^[A-Za-z0-9]{22}$

Body

application/json
include_associations
boolean
default:false

Also copy the source agent's metric and test-set associations.

Response

Agent duplicated successfully

agent
object
required

Agent configuration resource.

Note: The active field (soft delete status) is managed internally and not exposed in API responses.