---
title: "Create a voice agent or twin"
method: POST
path: "/voice/agents"
tags: ["Voice"]
---

# Create a voice agent or twin

`POST /voice/agents`

## Request

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

Create a new voice agent or twin bound to the caller's org.

Org is pinned server-side from the API key. The agent's creator is set
server-side too, never from the request body: an agent is credited to the
person who created the API key. A twin, or an agent created with a key
that records no creator, is credited to the key itself.

## Headers

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

## Request body

- VoiceAgentCreateRequest: Body for creating a voice agent or twin. Org is pinned server-side from the API key - never read from the body. ``created_by_email`` is likewise pinned to the calling principal (used upstream for one-twin-per-user enforcement and SDR/booking attribution); an org-wide API key has no per-human identity to attribute to beyond the key itself, so it is set to the same identifier the dialer-session and call routes already use for ``user_email``. Deliberately NOT exposed here (follow-up, not an oversight): twin-only fields ``tone_profile``, ``channels``, and ``persona_source_user_id``. They only apply when ``entity_type="twin"`` and none of this PR's priority surfaces (ad-hoc call, dialer sessions, dispositions) need them.
  - `agent_id` string, nullable: Agent UUID. Auto-generated if omitted.
  - `agent_status` 'active' | 'inactive' | 'archived': Initial status.
  - `role` string, required: Agent role (e.g. "SDR", "AE", "Receptionist", "CSM").
  - `entity_type` 'agent' | 'twin': "agent" or "twin".
  - `persona` VoiceAgentPersona, required: Persona / prompt configuration for a voice agent (mirrors V2 ``PersonaV2``).
    - `agent_name` string, required: Display name of the agent.
    - `persona` string, required: Personality and behavior description.
    - `formality_level` number, required: 0.0=casual, 1.0=formal.
    - `conciseness_level` number, required: 0.0=verbose, 1.0=brief.
    - `assertiveness_level` number, required: 0.0=passive, 1.0=assertive.
    - `description` string, required: Brief summary of the agent's purpose.
    - `inbound_instructions` string, nullable: Extra instructions for inbound calls.
    - `outbound_instructions` string, nullable: Extra instructions for outbound calls.
    - `outbound_voicemail_prompt` string, nullable: Voicemail message this agent leaves.
    - `company_name_pronunciation` string, nullable: TTS pronunciation override for the company name (e.g. 'Science' for 'CIENCE').
  - `identity` VoiceAgentIdentity, required: Communication-channel identity for a voice agent (mirrors V2 ``IdentityV2``).
    - `phone` string, nullable: Phone number in E.164 format (e.g. +15551234567). Optional.
    - `voice` string, nullable: Voice ID (Cartesia voice_id or OpenAI voice name). Optional.
    - `calendar` integer, nullable: Calendar/event-type system ID. Optional.
    - `avatar_url` string, nullable: URL of the agent's avatar image. Optional.
  - `knowledge` VoiceAgentKnowledge: Knowledge-collection attachments for a voice agent.
    - `collections` string[]: Collection IDs (max 4).
  - `use_company_knowledge` boolean: Also draw on the org-wide knowledge base.
  - `is_template` boolean: Save this as a reusable template rather than a live agent.
  - `template_id` string, nullable: Template this agent was cloned from, if any.

## Response `201`

Successful Response

- ApiResponseVoiceAgentResponse
  - `data` VoiceAgentResponse, required: Envelope for single-agent operations (create / get / update).
    - `agent` VoiceAgentDetail: Complete agent configuration, as returned by create/get/update.
      - `id` integer, required
      - `agent_id` string, required
      - `org_id` string, required
      - `agent_status` string, required
      - `role` string, required
      - `entity_type` string, required
      - `persona` VoiceAgentPersona, required: Persona / prompt configuration for a voice agent (mirrors V2 ``PersonaV2``).
        - `agent_name` string, required: Display name of the agent.
        - `persona` string, required: Personality and behavior description.
        - `formality_level` number, required: 0.0=casual, 1.0=formal.
        - `conciseness_level` number, required: 0.0=verbose, 1.0=brief.
        - `assertiveness_level` number, required: 0.0=passive, 1.0=assertive.
        - `description` string, required: Brief summary of the agent's purpose.
        - `inbound_instructions` string, nullable: Extra instructions for inbound calls.
        - `outbound_instructions` string, nullable: Extra instructions for outbound calls.
        - `outbound_voicemail_prompt` string, nullable: Voicemail message this agent leaves.
        - `company_name_pronunciation` string, nullable: TTS pronunciation override for the company name (e.g. 'Science' for 'CIENCE').
      - `identity` VoiceAgentIdentity, required: Communication-channel identity for a voice agent (mirrors V2 ``IdentityV2``).
        - `phone` string, nullable: Phone number in E.164 format (e.g. +15551234567). Optional.
        - `voice` string, nullable: Voice ID (Cartesia voice_id or OpenAI voice name). Optional.
        - `calendar` integer, nullable: Calendar/event-type system ID. Optional.
        - `avatar_url` string, nullable: URL of the agent's avatar image. Optional.
      - `knowledge` VoiceAgentKnowledge, required: Knowledge-collection attachments for a voice agent.
        - `collections` string[]: Collection IDs (max 4).
      - `use_company_knowledge` boolean, required
      - `is_template` boolean, required
      - `template_id` string, nullable
      - `created_by_email` string, nullable
      - `created_at` unknown
      - `updated_at` unknown
    - `message` string, nullable
  - `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)