Skip to content
Vocapable Developers

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 on every build and never hand-edited, so the reference cannot drift from the contract.

The reference covers what an API key can call. Browser-session surfaces (signup, native sign-in, the onboarding wizard) answer 401 to every API key by design and are deliberately not documented here; the first key is minted once in the browser, and everything after that is on these pages.

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

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 239a31550856f2b3d4ac474fc0f589f6b98622c1f5596694393f4e0734901826 (portal/openapi.json, Vocapable Control API).