Basics
- Base URL
https://api.telvana.com. Every request uses HTTPS.- Authentication
- Send your workspace API key in the
x-api-keyheader on every request. See Authentication. - Requests
- Send JSON bodies with
Content-Type: application/json. The one exception is document upload, which takesmultipart/form-data. - Responses
- Successful responses put their result in a
datafield, and some add amessage. Errors use one shape, described in Errors. - OpenAPI spec
- The machine-readable spec these pages are built from is at /docs/openapi.json.
Outbound calls
Queue a call from one of your agents to a phone number.
Conversations
Read finished calls with their transcript, summary, sentiment and tags.
Agents
Read an agent and change its prompts, settings and outbound prompts.
-
GET
/agents/{agentId}Get agent details -
GET
/agents/{agentId}/chat-promptGet website chat prompt -
PUT
/agents/{agentId}/chat-promptUpdate website chat prompt -
PUT
/agents/{agentId}/inbound-promptUpdate inbound prompt -
PUT
/agents/{agentId}/settingsUpdate agent settings -
GET
/agents/{agentId}/outbound-promptsList outbound prompts -
POST
/agents/{agentId}/outbound-promptsCreate outbound prompt -
GET
/agents/{agentId}/outbound-prompts/{promptId}Get outbound prompt -
PUT
/agents/{agentId}/outbound-prompts/{promptId}Update outbound prompt -
DELETE
/agents/{agentId}/outbound-prompts/{promptId}Delete outbound prompt
Knowledge bases
Create knowledge bases, upload documents and attach them to agents.
-
GET
/knowledge-basesList knowledge bases -
POST
/knowledge-basesCreate knowledge base -
GET
/knowledge-bases/workspaceList knowledge bases for dropdown -
GET
/knowledge-bases/{id}Get knowledge base -
PUT
/knowledge-bases/{id}Update knowledge base -
DELETE
/knowledge-bases/{id}Delete knowledge base -
GET
/knowledge-bases/{id}/documentsList documents -
POST
/knowledge-bases/{id}/documentsUpload document -
DELETE
/knowledge-bases/documents/{documentId}Delete document -
GET
/agents/{agentId}/knowledge-basesGet agent knowledge bases -
PUT
/agents/{agentId}/knowledge-basesUpdate agent knowledge bases
Tags
List the tags Telvana's call analysis can apply to a call.
Webhook payload
The request Telvana sends to your server when a call ends. Not an endpoint you call.