---
title: "Clone an agent, or instantiate one from a template"
method: POST
path: "/voice/agents/clone"
tags: ["Voice"]
---

# Clone an agent, or instantiate one from a template

`POST /voice/agents/clone`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/voice/agents/clone`
- Auth: HTTP bearer

Copy an agent's whole configuration under a new name.

Persona, identity and knowledge attachments come across. This is one call
where `POST /voice/agents` plus a dozen field copies would be several, and
it is how a template becomes a working agent.

NOT a link: the copy is independent, so later edits to the source do not
reach it.

`source_agent_id` is resolved WITHIN the caller's org, so a template id
from another tenant simply is not found.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- BodyCloneAgentVoiceAgentsClonePost
  - `source_agent_id` string, required: Agent or template to copy.
  - `new_agent_name` string, required: Name for the copy.
  - `new_agent_id` string, nullable: Id for the copy. Generated when omitted.
  - `role` string, nullable: Override the role.
  - `entity_type` string, nullable: Override: "agent" or "twin".
  - `overrides` object, nullable: Field overrides applied to the copy.

## Response `201`

Successful Response

- ApiResponseVoicePayload
  - `data` VoicePayload, required: One voice object - a collection, an agent, a route, a chat. Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)