Skip to content
vocapable.Docs

API reference

The reference pages in this section are generated from the committed OpenAPI 3.1 snapshot, the same document the product’s own portal types against. They are regenerated from that snapshot on every build and never hand-edited. The source version and hash appear at the end of this page.

Start with the resource you need. The generated operation pages list request schemas, required scopes, responses, and errors. A documented operation is not a grant: company state, deployment configuration, and runtime checks still apply.

Browser-session surfaces, including signup and onboarding, reject API-key authentication. Use the browser-owned company setup to obtain an authorized key; use that key only for operations within its grants.

  • Base URL: https://api.vocapable.com
  • Auth: Authorization: Bearer vcp_live_… or vcp_test_… (see Auth & scopes)
  • Operations: 1344, grouped by resource tag in the sidebar
  • Errors: every non-2xx is an RFC 9457 problem whose type resolves to the error registry

Find your resource

Section titled “Find your resource”

Identity and credentials

Confirm the authenticated company with GET /v1/me. Create purpose-scoped credentials and rotate them through /v1/api-keys. Start with authentication and scopes.

Agents and release readiness

Manage drafts through /v1/agents; check action prerequisites through GET /v1/agents/{agent_id}/skills. Publishing is a distinct operation with a release check. Read agent actions and readiness.

Calls and business outcomes

Read the company’s call ledger through GET /v1/calls, then inspect a call’s saved actions. See receiving results for transcripts, outcomes, and downstream synchronization.

Contacts and campaigns

Keep consent, contact data, and outbound qualification attached to the right company. Read campaigns and list scrubbing before starting an outbound workflow.

Signed events and delivery

Manage a company’s endpoint through /v1/webhook-endpoint. Verify signatures on the raw request, handle duplicate delivery, and queue accepted work. Read the webhook contract.

People, routing, and live readiness

Human destinations, group membership, and call readiness are separate from carrier execution. Read phone routing and fallback; readiness reads do not transfer a call.

Shared request conventions

Section titled “Shared request conventions”

Before reading individual operations, the conventions guide is the highest-leverage five minutes: IDs, cursor pagination, Idempotency-Key, rate limits, and ETag/304 apply uniformly to everything below.

Prefer a client workspace? The same spec is packaged as a Postman collection. Generated SDKs (Python and TypeScript) are planned but not yet available. Today, the spec plus the conventions above are designed to make direct HTTP integration predictable.

Generated from spec version 0.1.0, sha256 a332898b8ff032eb27a709a7c6c6c5fc51cca4c96ed492d381a5f6c6863f999d (portal/openapi.json, Vocapable Control API).