vocapableBuild with Vocapable
Integrate phone calls, agent actions, and saved outcomes with the systems your business already uses.
START HERE
Read your first call
Confirm your company, retrieve a call, and inspect its saved result. No dialing or billing changes required.
Open the quickstart →- Use an authorized company API key.
- Confirm its principal with
/v1/me. - Read saved calls with
/v1/calls.
curl --fail-with-body https://api.vocapable.com/v1/me \ -H "Authorization: Bearer $VOCAPABLE_API_KEY"Keep credentials on your server. Reading a call requires calls:read; inspecting the current principal requires authentication.
Build a workflow
Section titled “Build a workflow”API essentials
Section titled “API essentials”| Connection | Contract |
|---|---|
| Base URL | https://api.vocapable.com |
| Authentication | Authorization: Bearer <API key> |
| Company boundary | Resources belong to the company authorized by the credential. |
| Results | Signed HTTPS webhooks; at least once, without guaranteed order. |
| Error format | RFC 9457 application/problem+json, with stable error type URIs. |
| Full schemas | Generated API reference, from the committed OpenAPI 3.1 snapshot. |
Find the contract
Section titled “Find the contract”Use the generated reference to find each operation’s request fields, access rules, and response schema. The Postman collection uses the same source. Node.js and Python examples use ordinary HTTP clients; generated Vocapable SDKs are not currently available.
Account setup and API work
Section titled “Account setup and API work”Signup, company onboarding, checkout, and initial key setup are authenticated browser flows. A paid plan, acquired number, or saved setting alone does not activate a phone route. Follow the selected company’s actual readiness steps in the customer workspace.
Agent drafts, evaluation requests, supported campaign operations, and outcome retrieval have HTTP API surfaces. Publishing requires a passing scripted release check for the exact draft. That scripted stand-in is not a live model or carrier qualification. See agents and templates.
Workspace and headless integration
Section titled “Workspace and headless integration”Use Vocapable as the calling system of record, or keep your own system of record and connect contacts, eligible campaign work, and results through API and webhooks. There is no separate mode flag. Read headless mode and campaigns and scrub before implementing a dial path.
Simulated tests and production calls
Section titled “Simulated tests and production calls”An authorized vcp_test_ key routes telephony through the mock provider: calls
are deterministic simulations and do not dial the PSTN. Test mode does not grant
production access. Live calls require an eligible paid service, accepted terms,
and a qualified phone setup. Read test mode for the precise
simulation boundary and phone billing for
current BYO service and separately published managed-number offers.
Current production calling uses verified BYO Twilio accounts. Public managed number acquisition and supplied-phone outbound activation remain closed. Publishing a tariff does not activate its calling path.
Machine-readable documentation
Section titled “Machine-readable documentation”The API reference identifies its source version and SHA-256. The error registry preserves the stable meanings of the API’s error codes. llms.txt provides a machine-readable site summary.
AI disclosure, internal do-not-call suppression, and kill switches apply across calling entry points. On configured contact-bound phone calls, a caller opt-out saves the durable suppression; browser and simulated test calls do not have a real contact to suppress. These controls do not determine whether a business has the necessary permission to call a purchased or imported list.