API

Build on VeyCall.

A REST API for everything in the dashboard: agents, knowledge, conversations, leads and realtime voice sessions. Available on the Pro plan.

Open the interactive referenceDownload OpenAPI spec

Overview

All endpoints live under /api/v1. Requests and responses are JSON, except file uploads (multipart) and voice previews (MP3).

https://api.veycall.com/api/v1

Authentication

Send the access token of a signed-in VeyCall user as a bearer token. If the user belongs to several organizations, choose one with the x-organization-id header; otherwise their default organization is used.

Authorization: Bearer <access_token>
x-organization-id: <organization_id>

Requests are rate limited per user. If you receive 429, wait a moment and retry.

Responses and errors

Successful responses wrap the result in data. Lists are paginated with a cursor in meta.next_cursor; pass it back as cursor to get the next page.

{ "data": [ ... ], "meta": { "next_cursor": "..." } }

Errors return a matching HTTP status and a stable code you can check in your code:

{ "error": { "code": "NOT_FOUND", "message": "Agent not found" } }

Example

List your agents:

curl https://api.veycall.com/api/v1/agents \
  -H "Authorization: Bearer $VEYCALL_TOKEN"

Agents

  • GET/agentsList agents
  • POST/agentsCreate an agent
  • GET/agents/{agent_id}Get an agent
  • PATCH/agents/{agent_id}Update an agent
  • DELETE/agents/{agent_id}Delete an agent
  • POST/agents/{agent_id}/duplicateDuplicate an agent
  • POST/agents/{agent_id}/publishPublish an agent
  • POST/agents/{agent_id}/unpublishUnpublish an agent

Knowledge

  • GET/knowledgeList knowledge documents
  • POST/knowledgeAdd a website URL, text or FAQ
  • POST/knowledge/uploadUpload a PDF, DOCX, TXT or CSV file
  • GET/knowledge/{id}Get a document
  • POST/knowledge/{id}/reindexRe-process a document
  • DELETE/knowledge/{id}Delete a document

Conversations

  • GET/conversationsList conversations
  • GET/conversations/{id}Get a conversation with its captured lead
  • GET/conversations/{id}/messagesGet the transcript
  • DELETE/conversations/{id}Delete a conversation

Leads

  • GET/leadsList leads
  • POST/leadsCreate a lead
  • GET/leads/{id}Get a lead
  • PATCH/leads/{id}Update a lead's status or details
  • DELETE/leads/{id}Delete a lead

Voice sessions

  • GET/voicesList available voices
  • GET/voices/previewVoice preview audio (MP3)
  • POST/voice/sessionsCreate a voice session
  • POST/voice/sessions/{id}/endEnd a voice session
  • GET/realtimeRealtime voice WebSocket

Organization and usage

  • GET/meCurrent user and memberships
  • GET/organizationOrganization, plan and limits
  • GET/organization/membersList members
  • GET/usageUsage for a billing period
  • GET/usage/dailyDaily usage
  • GET/analytics/overviewConversation, lead and agent analytics