Agents

Create outbound prompt

Create a new outbound prompt for an agent

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

Path parameters

agentIdstring required
Example:jm1u1cawc7dka1x84mrjvb4y

Unique identifier for the agent

Request body

titlestring required

Title of the outbound prompt

instructionsstring required

Instructions/prompt for outbound calls

openingstring 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"}}

personaNamestring nullable

Name the assistant gives on this prompt (GPT-Live voice card)

businessNamestring nullable

Business this prompt calls for, as spoken (GPT-Live voice card)

voicePromptstring 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

Outbound prompt created successfully

messagestring

Example response

{
  "data": {
    "id": "prompt_xyz789",
    "title": "Appointment Reminder",
    "instructions": "Call {{firstName}} to remind them of their appointment at {{appointmentTime}}. Be friendly and confirm they can still make it.",
    "agentId": "jm1u1cawc7dka1x84mrjvb4y",
    "createdAt": "2025-01-15T00:00:00.000Z",
    "updatedAt": "2025-01-15T00:00:00.000Z"
  },
  "message": "Outbound prompt created successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.