1 min de leitura

REST API endpoints reference

Sharan Karthikeyan·24 de abril de 2026

Available endpoints

All endpoints are relative to your VoiceCraft instance base URL. Session-authenticated routes require a valid login. Webhook routes require the x-api-key header.

Agents

Method	Endpoint	Description
GET	`/api/agents`	List all agents (add `?deleted=true` for trash)
POST	`/api/agents`	Create a new agent
GET	`/api/agents/[id]`	Get agent details
PATCH	`/api/agents/[id]`	Update agent configuration
DELETE	`/api/agents/[id]`	Soft-delete an agent

Calls

Method	Endpoint	Description
GET	`/api/calls`	List calls (filterable by agent, outcome, date)
POST	`/api/calls`	Log a call (from gateway/agent worker)
GET	`/api/calls/[id]`	Call detail with transcript
GET	`/api/calls/[id]/recording`	Call recording audio
GET	`/api/calls/[id]/voicemail`	Voicemail transcription
GET	`/api/calls/[id]/citations`	Knowledge base references used

Contacts

Method	Endpoint	Description
GET	`/api/contacts`	List all contacts
POST	`/api/contacts`	Create a contact
PATCH	`/api/contacts/[id]`	Update a contact

Appointments

Method	Endpoint	Description
GET	`/api/appointments`	List appointments
POST	`/api/appointments`	Create an appointment
GET	`/api/appointments/[id]`	Appointment detail

Messages

Method	Endpoint	Description
GET	`/api/messages`	List conversation threads
POST	`/api/messages`	Send a message
GET	`/api/messages/[conversationId]`	Thread detail

Forms

Method	Endpoint	Description
GET/POST	`/api/forms/templates`	List or create form templates
GET/POST	`/api/forms/submissions`	List or create submissions
GET	`/api/forms/submissions/[id]`	Submission detail
POST	`/api/forms/submissions/[id]/amend`	Edit a submission
POST	`/api/forms/submissions/[id]/export.pdf`	Export as PDF
POST	`/api/forms/submissions/[id]/tombstone`	Redact PII (HIPAA)

Orders

Method	Endpoint	Description
GET/POST	`/api/orders`	List or create orders

Analytics

Method	Endpoint	Description
GET	`/api/analytics`	Aggregated workspace metrics

Knowledge

Method	Endpoint	Description
GET/POST	`/api/knowledge`	List or upload documents

Notifications

Method	Endpoint	Description
GET	`/api/notifications`	Notification feed
PATCH	`/api/notifications/[id]`	Mark as read

Team

Method	Endpoint	Description
GET/POST	`/api/team`	List or invite members
POST	`/api/team/[userId]/remove`	Remove a member
PATCH	`/api/team/[userId]/role`	Change a member's role

All list endpoints support cursor-based pagination.

Este artigo foi útil?