8 मिनट पढ़ने का समय

REST API endpoints reference

Sharan Karthikeyan·26 मई 2026

All endpoints are relative to your VoiceCraft instance base URL. Session-authenticated routes require a valid login. Webhook routes called by the voice agent require the x-api-key header set to your VOICECRAFT_API_KEY value.

Agents

Method	Endpoint	Description
GET	`/api/agents`	List all agents. Add `?deleted=true` to include soft-deleted agents.
POST	`/api/agents`	Create a new agent. Requires Owner or Admin role.
GET	`/api/agents/[id]`	Get agent details.
PUT	`/api/agents/[id]`	Update agent configuration. Requires Owner or Admin role.
DELETE	`/api/agents/[id]`	Soft-delete an agent. Requires Owner or Admin role.
POST	`/api/agents/[id]/deploy`	Deploy agent (set it live). Requires Owner or Admin role.
POST	`/api/agents/[id]/provision-number`	Provision a phone number for the agent. Requires Owner or Admin role.
DELETE	`/api/agents/[id]/provision-number`	Release the agent's provisioned phone number. Requires Owner or Admin role.
POST	`/api/agents/[id]/clone`	Duplicate an agent. Requires Owner or Admin role.
POST	`/api/agents/[id]/restore`	Restore a soft-deleted agent. Requires Owner or Admin role.
POST	`/api/agents/[id]/purge`	Permanently delete a soft-deleted agent. Requires Owner role only.
PATCH	`/api/agents/[id]/capabilities`	Update agent capability flags. Requires Owner or Admin role.
GET	`/api/agents/[id]/tool-overrides`	Get per-agent tool configuration overrides.
GET	`/api/agents/[id]/order-settings`	Get voice-commerce order settings for the agent.
PUT	`/api/agents/[id]/order-settings`	Update voice-commerce order settings. Requires Owner or Admin role.
POST	`/api/agents/[id]/preview-voice`	Generate a voice preview sample for the agent's TTS settings.
GET	`/api/agents/[id]/sequences`	List follow-up message sequences for the agent.
PUT	`/api/agents/[id]/sequences`	Update follow-up message sequences. Requires Owner or Admin role.
GET	`/api/agents/[id]/knowledge`	List knowledge chunks attached to the agent.
POST	`/api/agents/[id]/knowledge`	Attach a knowledge chunk to the agent. Requires Owner or Admin role.
GET	`/api/agents/[id]/knowledge/documents`	List knowledge documents for the agent.
POST	`/api/agents/[id]/knowledge/documents`	Upload a new knowledge document. Requires Owner or Admin role.
GET	`/api/agents/[id]/knowledge-gaps`	List unanswered questions the agent encountered during calls.
POST	`/api/agents/[id]/whatsapp`	Add a WhatsApp number to the agent. Requires Owner or Admin role.
DELETE	`/api/agents/[id]/whatsapp`	Remove the WhatsApp number from the agent. Requires Owner or Admin role.
POST	`/api/agents/[id]/whatsapp/connect`	Initiate WhatsApp embedded signup connection. Requires Owner or Admin role.
POST	`/api/agents/[id]/whatsapp/disconnect`	Disconnect the WhatsApp integration. Requires Owner or Admin role.

Calls

Method	Endpoint	Description
GET	`/api/calls`	List calls. Filterable by agent, outcome, and date.
POST	`/api/calls`	Log a call record (called by the agent worker). Uses `x-api-key` auth.
GET	`/api/calls/[id]`	Call detail with transcript.
PATCH	`/api/calls/[id]`	Update call metadata (e.g. outcome notes).
GET	`/api/calls/[id]/recording`	Stream or download the call recording audio.
DELETE	`/api/calls/[id]/recording`	Delete the call recording.
GET	`/api/calls/[id]/voicemail`	Get voicemail transcription for the call.
GET	`/api/calls/[id]/citations`	List knowledge base chunks cited during the call.
GET	`/api/calls/[id]/tools`	List tool calls made by the agent during the call.
POST	`/api/calls/[id]/gaps`	Submit unanswered questions identified during the call.

Contacts

Method	Endpoint	Description
GET	`/api/contacts`	List all contacts.
POST	`/api/contacts`	Create a contact.
GET	`/api/contacts/[id]`	Get contact details.
PATCH	`/api/contacts/[id]`	Update a contact.
POST	`/api/contacts/[id]/consent`	Record or update a contact's messaging consent.
GET	`/api/contacts/[id]/story`	Get the synthesized contact story.
POST	`/api/contacts/[id]/story`	Trigger story regeneration for a contact.
POST	`/api/contacts/import`	Bulk import contacts from CSV.

Appointments

Method	Endpoint	Description
GET	`/api/appointments`	List appointments.
POST	`/api/appointments`	Create an appointment.
PATCH	`/api/appointments/[id]`	Update an appointment.

Messages

Method	Endpoint	Description
GET	`/api/messages`	List conversation threads.
POST	`/api/messages`	Send a message.
GET	`/api/messages/[conversationId]`	Get thread detail.
PATCH	`/api/messages/[conversationId]`	Update thread state (e.g. mark handled).

Orders

Method	Endpoint	Description
GET	`/api/orders`	List voice-commerce orders.
GET	`/api/orders/[id]`	Get order detail.
PATCH	`/api/orders/[id]/status`	Update order status.
POST	`/api/orders/[id]/cancel`	Cancel an order.
POST	`/api/orders/[id]/contact-customer`	Send a message to the customer for this order.
POST	`/api/orders/[id]/issues/[issueId]/resolve`	Mark a flagged order issue as resolved.

Catalog (voice commerce)

Method	Endpoint	Description
GET	`/api/catalog/[agentId]`	Get the full catalog for an agent.
POST	`/api/catalog/items`	Create a catalog item.
GET	`/api/catalog/items/[id]`	Get a catalog item.
PATCH	`/api/catalog/items/[id]`	Update a catalog item.
DELETE	`/api/catalog/items/[id]`	Delete a catalog item.
PATCH	`/api/catalog/items/[id]/availability`	Toggle a catalog item's availability.
POST	`/api/catalog/categories`	Create a catalog category.
PATCH	`/api/catalog/categories/[id]`	Update a category.
DELETE	`/api/catalog/categories/[id]`	Delete a category.
POST	`/api/catalog/modifier-groups`	Create a modifier group.
POST	`/api/catalog/modifiers`	Create a modifier within a group.
POST	`/api/catalog/[agentId]/import-csv`	Preview a CSV import diff for the agent's catalog.
POST	`/api/catalog/[agentId]/import-csv/apply`	Apply a previewed CSV import to the catalog.

Forms

Method	Endpoint	Description
GET	`/api/forms/templates`	List form templates.
POST	`/api/forms/templates`	Create a form template.
GET	`/api/forms/templates/[id]`	Get a form template.
PUT	`/api/forms/templates/[id]`	Update a form template.
DELETE	`/api/forms/templates/[id]`	Delete a form template.
POST	`/api/forms/templates/[id]/activate`	Activate a form template.
POST	`/api/forms/templates/[id]/archive`	Archive a form template.
POST	`/api/forms/templates/[id]/agents`	Assign the template to an agent.
DELETE	`/api/forms/templates/[id]/agents`	Remove the template from an agent.
GET	`/api/forms/submissions`	List form submissions.
GET	`/api/forms/submissions/[id]`	Get a submission.
POST	`/api/forms/submissions/[id]/amend`	Edit a submitted form.
POST	`/api/forms/submissions/[id]/export.pdf`	Export a submission as PDF.
POST	`/api/forms/submissions/[id]/tombstone`	Redact PII from a submission (HIPAA).
GET	`/api/forms/submissions/export.csv`	Export all submissions as CSV.

Knowledge

Method	Endpoint	Description
GET	`/api/knowledge`	List knowledge entries in the workspace.
GET	`/api/knowledge/[id]`	Get a knowledge entry.
PATCH	`/api/knowledge/[id]`	Update a knowledge entry.
DELETE	`/api/knowledge/[id]`	Delete a knowledge entry.
POST	`/api/knowledge/[id]/attach`	Attach a knowledge entry to an agent.
DELETE	`/api/knowledge/[id]/attach`	Detach a knowledge entry from an agent.
POST	`/api/knowledge/upload`	Upload a file to the knowledge base.
POST	`/api/knowledge/scrape`	Scrape a URL and add it to the knowledge base.
POST	`/api/knowledge/faq`	Add a FAQ entry to the knowledge base.

Analytics

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

Exports

Method	Endpoint	Description
GET	`/api/exports/calls`	Export call records.
GET	`/api/exports/analytics`	Export analytics data.

Notifications

Method	Endpoint	Description
GET	`/api/notifications`	Get the notification feed.
POST	`/api/notifications/[id]/read`	Mark a notification as read.
POST	`/api/notifications/mark-all-read`	Mark all notifications as read.
GET	`/api/notifications/preferences`	Get notification preferences.
PATCH	`/api/notifications/preferences`	Update notification preferences.

Team

Method	Endpoint	Description
GET	`/api/team`	List team members.
PATCH	`/api/team`	Update team-level settings.
PATCH	`/api/team/members/[id]`	Update a member's role.
DELETE	`/api/team/members/[id]`	Remove a member from the workspace.
POST	`/api/team/members/[id]/transfer-ownership`	Transfer workspace ownership to this member.
POST	`/api/team/invite`	Send a team invitation.
DELETE	`/api/team/invite/[id]`	Cancel a pending invitation.
POST	`/api/team/invite/[id]/resend`	Resend a pending invitation.

Organization

Method	Endpoint	Description
DELETE	`/api/organization`	Delete the organization.
GET	`/api/organization/retention`	Get data retention settings.
PUT	`/api/organization/retention`	Update data retention settings.
GET	`/api/organization/spend-cap`	Get the daily spend cap.
PATCH	`/api/organization/spend-cap`	Update the daily spend cap.

Billing

Method	Endpoint	Description
GET	`/api/billing/status`	Get current plan and billing status.
GET	`/api/billing/usage`	Get usage for the current billing period.
POST	`/api/billing/checkout`	Start a Stripe checkout session.
POST	`/api/billing/portal`	Open the Stripe billing portal.
POST	`/api/billing/switch-plan`	Switch to a different plan.

Campaigns (voice outreach)

Method	Endpoint	Description
GET	`/api/campaigns`	List voice campaigns.
POST	`/api/campaigns`	Create a voice campaign.
GET	`/api/campaigns/[id]`	Get campaign detail.
DELETE	`/api/campaigns/[id]`	Delete a campaign.

SMS campaigns

Method	Endpoint	Description
GET	`/api/sms-campaigns`	List SMS campaigns.
POST	`/api/sms-campaigns`	Create an SMS campaign.
GET	`/api/sms-campaigns/[id]`	Get SMS campaign detail.
PATCH	`/api/sms-campaigns/[id]`	Update an SMS campaign.
DELETE	`/api/sms-campaigns/[id]`	Delete an SMS campaign.
POST	`/api/sms-campaigns/[id]/launch`	Launch an SMS campaign.
POST	`/api/sms-campaigns/[id]/cancel`	Cancel an SMS campaign.

Phone numbers

Method	Endpoint	Description
GET	`/api/phone-numbers`	List phone numbers in the workspace.
GET	`/api/phone-numbers/search`	Search available numbers to provision.

Integrations

Method	Endpoint	Description
GET	`/api/integrations/google`	Start Google Calendar OAuth flow.
DELETE	`/api/integrations/google/disconnect`	Disconnect Google Calendar.
GET	`/api/integrations/square`	Start Square POS OAuth flow.
DELETE	`/api/integrations/square/disconnect`	Disconnect Square.
GET	`/api/integrations/clover`	Start Clover POS OAuth flow.
DELETE	`/api/integrations/clover/disconnect`	Disconnect Clover.
GET	`/api/integrations/hubspot`	Start HubSpot OAuth flow.
DELETE	`/api/integrations/hubspot/disconnect`	Disconnect HubSpot.
GET	`/api/integrations/microsoft`	Start Microsoft Calendar OAuth flow.
DELETE	`/api/integrations/microsoft/disconnect`	Disconnect Microsoft Calendar.

User

Method	Endpoint	Description
PATCH	`/api/user/profile`	Update the current user's profile.
PATCH	`/api/user/password`	Change the current user's password.
DELETE	`/api/user`	Delete the current user account.

Search and inbox

Method	Endpoint	Description
GET	`/api/search`	Global search across agents, contacts, calls, and more.
GET	`/api/inbox`	Unified inbox of unhandled conversations.

LiveKit

Method	Endpoint	Description
POST	`/api/livekit/token`	Generate a LiveKit room token (for browser-based test calls).

Webhooks (voice agent)

These endpoints are called by the voice agent worker, not by the dashboard. All require the x-api-key header.

Telephony

Method	Endpoint	Description
POST	`/api/webhooks/twilio-voice`	Inbound call routing — Twilio calls this and receives TwiML in response.
POST	`/api/webhooks/plivo-voice`	Inbound call routing — Plivo calls this and receives XML in response.
POST	`/api/webhooks/twilio-sms`	Inbound SMS from Twilio.
POST	`/api/webhooks/plivo-sms`	Inbound SMS from Plivo.
POST	`/api/webhooks/plivo-status`	Delivery status updates from Plivo.
POST	`/api/webhooks/twilio-whatsapp`	Inbound WhatsApp messages from Twilio.
POST	`/api/webhooks/twilio-whatsapp-status`	WhatsApp delivery status updates from Twilio.
POST	`/api/webhooks/livekit`	LiveKit room event webhooks.
POST	`/api/webhooks/stripe`	Stripe billing event webhooks.

Scheduling

Method	Endpoint	Description
POST	`/api/webhooks/availability`	Check appointment availability.
POST	`/api/webhooks/book`	Book an appointment.
POST	`/api/webhooks/cancel-appointment`	Cancel an appointment.
POST	`/api/webhooks/reschedule-appointment`	Reschedule an appointment.
POST	`/api/webhooks/appointment-lookup`	Look up an existing appointment.
POST	`/api/webhooks/calendar-events-for-date`	Get calendar events for a given date.

Messaging and contacts

Method	Endpoint	Description
POST	`/api/webhooks/send-sms`	Send an SMS during or after a call.
POST	`/api/webhooks/take-message`	Record a message from the caller.
POST	`/api/webhooks/request-callback`	Log a callback request.
POST	`/api/webhooks/contact-lookup`	Look up or create a contact by phone number.
POST	`/api/webhooks/add-to-waitlist`	Add a caller to a waitlist.

Voice commerce orders

Method	Endpoint	Description
POST	`/api/webhooks/order-start`	Start a new order session.
POST	`/api/webhooks/order-line`	Add a line item to an in-progress order.
POST	`/api/webhooks/order-line-remove`	Remove a line item from an in-progress order.
POST	`/api/webhooks/order-submit`	Submit a completed order.
POST	`/api/webhooks/order-abandon`	Mark an order session as abandoned.
POST	`/api/webhooks/order-cancel`	Cancel a submitted order.

POS sync

Method	Endpoint	Description
POST	`/api/webhooks/pos/square`	Square POS webhook events.
POST	`/api/webhooks/pos/clover`	Clover POS webhook events.

Forms

Method	Endpoint	Description
POST	`/api/webhooks/form-start`	Signal that the agent began collecting a form.
POST	`/api/webhooks/form-field`	Submit a single form field value.
POST	`/api/webhooks/form-submit`	Submit a completed form.
POST	`/api/webhooks/form-abandon`	Mark a form session as abandoned.

All list endpoints support cursor-based pagination where applicable.

क्या यह लेख उपयोगी था?

Agents

Calls

Contacts

Appointments

Messages

Orders

Catalog (voice commerce)

Forms

Knowledge

Analytics

Exports

Notifications

Team

Organization

Billing

Campaigns (voice outreach)

SMS campaigns

Phone numbers

Integrations

User

Search and inbox

LiveKit

Webhooks (voice agent)

Telephony

Scheduling

Messaging and contacts

Voice commerce orders

POS sync

Forms

संबंधित लेख