Voicetta
    Sign InGet Started

    API Reference

    Partner API for calls, messages, and threads, and Setup API for agent-to-agent provisioning.

    Partner API

    Assistants, calls, messages, and threads. Authenticate with Authorization: Bearer <key>. Spec: /partner-openapi.json

    Assistants

    Agents in this workspace, with the numbers and variables a call needs.

    • GETList assistants/v1/assistants

    Calls

    Start a call, then read it back, including its recording.

    • GETList calls/v1/calls
    • POSTStart a call/v1/calls
    • GETGet call/v1/calls/{call_id}
    • GETGet call recording/v1/calls/{call_id}/recording

    Messages

    SMS and WhatsApp messages.

    • GETList messages/v1/messages
    • GETGet message/v1/messages/{message_id}

    Threads

    Completed SMS and WhatsApp conversations.

    • GETList threads/v1/threads
    • GETGet thread/v1/threads/{thread_id}

    Webhooks

    Events Voicetta POSTs to your server. Not routes you call.

    • POSTCall completedcall.completed
    • POSTCall startedcall.started
    • POSTMessage receivedmessage.received
    • POSTMessage sentmessage.sent
    • POSTThread completedthread.completed

    Setup API

    Agent-to-agent provisioning. Create a session, wait for owner consent, then claim a scoped bearer. Spec: /setup-openapi.json

    Catalog

    Setup tools an agent can select. UI label: Connection.

    • GETTerminology/v1/setup/openapi-note
    • GETList tools/v1/setup/tools/catalog
    • GETGet tool/v1/setup/tools/catalog/{tool_id}

    Sessions

    Create a session, consent, and claim a bearer.

    • POSTCreate session/v1/setup/sessions
    • GETGet session/v1/setup/sessions/{session_id}
    • POSTClaim access token/v1/setup/sessions/{session_id}/claim
    • POSTGrant consent/v1/setup/sessions/{session_id}/consent
    • GETPreview consent/v1/setup/sessions/{session_id}/consent-preview

    Steps

    Profile, assistant, knowledge, phone, and human steps.

    • POSTAdvance session/v1/setup/sessions/{session_id}/advance
    • POSTConfigure assistant/v1/setup/sessions/{session_id}/assistant
    • POSTComplete human step/v1/setup/sessions/{session_id}/human-step/complete
    • POSTUpload knowledge/v1/setup/sessions/{session_id}/knowledge
    • POSTRequest phone number/v1/setup/sessions/{session_id}/phone
    • POSTConfirm payment/v1/setup/sessions/{session_id}/phone/confirm-payment
    • POSTMark phone provisioned/v1/setup/sessions/{session_id}/phone/provisioned
    • POSTSubmit profile/v1/setup/sessions/{session_id}/profile
    • POSTRecord test call/v1/setup/sessions/{session_id}/test-call

    Tools

    Select, enable, or skip tools for this session.

    • GETGet tool status/v1/setup/sessions/{session_id}/tools
    • POSTSelect tools/v1/setup/sessions/{session_id}/tools/select
    • POSTEnable tool/v1/setup/sessions/{session_id}/tools/{tool_id}/enable
    • POSTSkip tool/v1/setup/sessions/{session_id}/tools/{tool_id}/skip

    Handoff

    Webhook registration and the final handoff card.

    • GETGet handoff/v1/setup/sessions/{session_id}/handoff
    • POSTRegister webhook/v1/setup/sessions/{session_id}/webhooks/register