Agents

Retrieve only the website chat prompt for an agent in the API key's workspace.

Path parameters

Example request

curl "https://api.telvana.com/agents/{agentId}/chat-prompt" \
  -H "x-api-key: $TELVANA_API_KEY"

Response 200

Chat prompt retrieved successfully. Errors use the format in Errors .

Replace only the website chat prompt for an agent in the API key's workspace.

Path parameters

Request body (application/json)

Example request

curl -X PUT "https://api.telvana.com/agents/{agentId}/chat-prompt" \
  -H "x-api-key: $TELVANA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "chatPrompt": "<chatPrompt>"
  }'

Response 200

Chat prompt updated successfully. Errors use the format in Errors .

Update the inbound prompt for an agent.

Path parameters

Request body (application/json)

Example request

curl -X PUT "https://api.telvana.com/agents/{agentId}/inbound-prompt" \
  -H "x-api-key: $TELVANA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "inboundPrompt": "You are a helpful customer service agent for Acme Corp. Be polite and helpful."
  }'

Response 200

Inbound prompt updated successfully. Errors use the format in Errors .

{
  "data": {
    "id": "jm1u1cawc7dka1x84mrjvb4y",
    "name": "Customer Service Agent",
    "inboundPrompt": "You are a helpful customer service agent for Acme Corp. Be polite and helpful."
  },
  "message": "Inbound prompt updated successfully"
}

Update agent configuration settings including call transfer, multilingual support, webhooks, and more.

Path parameters

Request body (application/json)

Example request

curl -X PUT "https://api.telvana.com/agents/{agentId}/settings" \
  -H "x-api-key: $TELVANA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "hasCallTransfer": true,
    "hasEndCall": true,
    "hasBargeIn": true,
    "language": "en-US",
    "voiceId": "pNInz6obpgDQGcFmaJgB",
    "personaName": "Marin",
    "businessName": "Butterfly",
    "inboundGreeting": "Thanks for calling Butterfly, this is Marin. How can I help?",
    "voiceScope": "Trip reminders and questions about a scheduled ride.",
    "voiceTone": "calm",
    "inboundVoicePrompt": "You are Marin, the voice of Butterfly. Open with: \"Thanks for calling Butterfly, this is Marin. How can I help?\" Then hand every request to the assistant."
  }'

Response 200

Agent settings updated successfully. Errors use the format in Errors .

{
  "data": {
    "id": "jm1u1cawc7dka1x84mrjvb4y",
    "hasCallTransfer": true,
    "hasEndCall": true,
    "hasBargeIn": true,
    "language": "en-US"
  },
  "message": "Agent settings updated successfully"
}

Retrieve all outbound prompts for an agent.

Path parameters

Example request

curl "https://api.telvana.com/agents/{agentId}/outbound-prompts" \
  -H "x-api-key: $TELVANA_API_KEY"

Response 200

Outbound prompts retrieved successfully. Errors use the format in Errors .

{
  "data": [
    {
      "id": "prompt_abc123",
      "title": "Appointment Confirmation",
      "instructions": "Call to confirm the appointment for {{firstName}} at {{appointmentTime}}.",
      "agentId": "jm1u1cawc7dka1x84mrjvb4y",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z"
    },
    {
      "id": "prompt_def456",
      "title": "Follow-up Call",
      "instructions": "Follow up with {{firstName}} regarding their recent inquiry.",
      "agentId": "jm1u1cawc7dka1x84mrjvb4y",
      "createdAt": "2025-01-02T00:00:00.000Z",
      "updatedAt": "2025-01-02T00:00:00.000Z"
    }
  ]
}

Create a new outbound prompt for an agent.

Path parameters

Request body (application/json)

Example request

curl -X POST "https://api.telvana.com/agents/{agentId}/outbound-prompts" \
  -H "x-api-key: $TELVANA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Appointment Reminder",
    "instructions": "Call {{firstName}} to remind them of their appointment at {{appointmentTime}}. Be friendly and confirm they can still make it.",
    "opening": "Hi {{firstName}}, this is Butterfly calling about your appointment at {{appointmentTime}}.",
    "voicePrompt": "You are the voice of Butterfly on a reminder call. Open with: \"Hi {{firstName}}, this is Butterfly calling about your appointment at {{appointmentTime}}.\" Confirm it, then hand every other request to the assistant."
  }'

Response 201

Outbound prompt created successfully. Errors use the format in Errors .

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

Retrieve a specific outbound prompt by ID.

Path parameters

Example request

curl "https://api.telvana.com/agents/{agentId}/outbound-prompts/{promptId}" \
  -H "x-api-key: $TELVANA_API_KEY"

Response 200

Outbound prompt retrieved successfully. Errors use the format in Errors .

{
  "data": {
    "id": "prompt_abc123",
    "title": "Appointment Confirmation",
    "instructions": "Call to confirm the appointment for {{firstName}} at {{appointmentTime}}.",
    "agentId": "jm1u1cawc7dka1x84mrjvb4y",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  }
}

Update an existing outbound prompt.

Path parameters

Request body (application/json)

Example request

curl -X PUT "https://api.telvana.com/agents/{agentId}/outbound-prompts/{promptId}" \
  -H "x-api-key: $TELVANA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Updated Appointment Confirmation",
    "instructions": "Call {{firstName}} to confirm their appointment at {{appointmentTime}}. Be professional and courteous.",
    "opening": "Hi {{firstName}}, this is Butterfly confirming your appointment at {{appointmentTime}}.",
    "voicePrompt": "You are the voice of Butterfly on a confirmation call. Open with: \"Hi {{firstName}}, this is Butterfly confirming your appointment at {{appointmentTime}}.\" Confirm it, then hand every other request to the assistant."
  }'

Response 200

Outbound prompt updated successfully. Errors use the format in Errors .

{
  "data": {
    "id": "prompt_abc123",
    "title": "Updated Appointment Confirmation",
    "instructions": "Call {{firstName}} to confirm their appointment at {{appointmentTime}}. Be professional and courteous.",
    "agentId": "jm1u1cawc7dka1x84mrjvb4y",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-15T00:00:00.000Z"
  },
  "message": "Outbound prompt updated successfully"
}

Delete an outbound prompt.

Path parameters

Example request

curl -X DELETE "https://api.telvana.com/agents/{agentId}/outbound-prompts/{promptId}" \
  -H "x-api-key: $TELVANA_API_KEY"

Response 200

Outbound prompt deleted successfully. Errors use the format in Errors .

{
  "data": null,
  "message": "Outbound prompt deleted successfully"
}