Postman collection

The collection is generated at build time from the same committed OpenAPI 3.1 snapshot as the API reference, with requests foldered by resource tag.

Download the collection

Set two variables

The collection authenticates every request with collection-level bearer auth referencing {{apiKey}}, against {{baseUrl}}:

Variable	Value
baseUrl	https://api.vocapable.com (pre-set)
apiKey	Your key; start with a vcp_test_… key

In Postman: import the file, open the collection’s Variables tab, paste your key into apiKey, and save. Use a test key first: vcp_test_ keys are free, route all telephony to a simulated provider, and exercise the full dial pipeline without a single PSTN call; see Test mode.

A sensible first run

1. identity → GET /v1/me confirms the key, tenant, mode, and scopes.
2. agents → GET /v1/templates browses the template library.
3. Follow the Quickstart order for the rest: create a no-tool draft, request the built-in scripted release check, wait for the deployed release worker to pass that exact draft, then publish it. Then verify a number and place a simulated test call. Simulated calls do not execute contact-bound tools. On configured live phone calls, use only check_calendar, book_meeting, schedule_callback, record_optout, and end_call; calendar actions also need an active direct Google Calendar connection.

Two conventions the collection cannot click for you: add an Idempotency-Key header (any UUID) on POST /v1/campaigns/{id}/launch, where it is required, and honor Retry-After on 429. Details in Conventions.

Generated from spec version 0.1.0, sha256 239a31550856f2b3d4ac474fc0f589f6b98622c1f5596694393f4e0734901826 (portal/openapi.json). The collection’s description carries the same stamp, so a downloaded copy is always traceable to the exact spec bytes it was built from.