---
title: "Create outbound prompt"
method: POST
path: "/agents/{agentId}/outbound-prompts"
tags: ["Agents"]
---

# Create outbound prompt

`POST /agents/{agentId}/outbound-prompts`

## Request

- Base URL: `https://api.telvana.com`
- URL: `https://api.telvana.com/agents/{agentId}/outbound-prompts`
- Auth: API key in header `x-api-key`

Create a new outbound prompt for an agent

## Path parameters

- `agentId` string, required

## Request body

- object
  - `title` string, required: Title of the outbound prompt
  - `instructions` string, required: Instructions/prompt for outbound calls
  - `opening` string, nullable: Exact opening line for GPT-Live voices; {{variables}} allowed, and the line may choose between two texts by comparing a variable with a number, as {{count < 2 ? "text when under two" : "text otherwise, {{count}} allowed here too"}}
  - `personaName` string, nullable: Name the assistant gives on this prompt (GPT-Live voice card)
  - `businessName` string, nullable: Business this prompt calls for, as spoken (GPT-Live voice card)
  - `voicePrompt` string, nullable: Optional hand-written prompt for the GPT-Live voice model on this outbound prompt's calls, opening line included; the full prompt still drives the backend. Omit or null for none

## Response `201`

Outbound prompt created successfully

- object
  - `data` object
    - `id` string, required: Unique identifier for the outbound prompt
    - `title` string, required: Title of the outbound prompt
    - `instructions` string, required: Instructions/prompt for outbound calls
    - `opening` string, nullable, required: Exact opening line for GPT-Live voices; {{variables}} allowed, and the line may choose between two texts by comparing a variable with a number, as {{count < 2 ? "text when under two" : "text otherwise, {{count}} allowed here too"}}
    - `personaName` string, nullable, required: Name the assistant gives on this prompt
    - `businessName` string, nullable, required: Business this prompt calls for, as spoken
    - `scope` string, nullable, required: What this prompt helps with, derived from it
    - `voiceCardEdited` boolean, required: True once this card was edited by hand
    - `voicePrompt` string, nullable, required: Hand-written GPT-Live voice prompt for this outbound prompt, opening line included; replaces the voice card for the voice model
    - `singlePrompt` string, nullable, required: This prompt in the single-prompt template; while set, instructions, voicePrompt and opening are rendered from it
    - `agentId` string, required: ID of the agent this prompt belongs to
    - `createdAt` string, date-time, required: Creation timestamp
    - `updatedAt` string, date-time, required: Last update timestamp
  - `message` string

## Other responses

- `400`: Bad request - Invalid input
- `401`: Unauthorized - Invalid API key
- `404`: Agent not found

---

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