# TokBox API

**Canonical:** https://apis.io/apis/tokbox/tokbox-api/  
**Provider:** TokBox — https://apis.io/providers/tokbox/  
**Documentation:** https://developer.vonage.com/en/voice/voice-api/webhook-reference

TokBox API is published by [TokBox](https://apis.io/providers/tokbox/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

TokBox API as documented publicly: 43 operations. Contract generated from the documentation by API Evangelist (2026-10-25); not the provider's own document.

## Operations (43)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | GET / |
| POST | `/calls` | POST /calls request can include return_cps_on_started to receive CPS fields in the started event payload. |
| GET | `/graphql` | GET /graphql |
| POST | `/graphql` | POST /graphql |
| GET | `/install/repositories/tokbox/debian/script.deb.sh` | GET /install/repositories/tokbox/debian/script.deb.sh |
| POST | `/session/create` | POST /session/create |
| POST | `/v1/calls` | POST /v1/calls |
| PATCH | `/v2/project/$apiKey/archive/$ARCHIVE_ID/streams` | PATCH /v2/project/$apiKey/archive/$ARCHIVE_ID/streams |
| PUT | `/v2/project/$apiKey/archive/$archiveId/layout` | PUT /v2/project/$apiKey/archive/$archiveId/layout |
| POST | `/v2/project/$apiKey/broadcast` | POST /v2/project/$apiKey/broadcast |
| PATCH | `/v2/project/$apiKey/broadcast/$BROADCAST_ID/streams` | PATCH /v2/project/$apiKey/broadcast/$BROADCAST_ID/streams |
| PUT | `/v2/project/$apiKey/broadcast/$broadcastId/layout` | PUT /v2/project/$apiKey/broadcast/$broadcastId/layout |
| PUT | `/v2/project/$apiKey/session/$sessionId` | PUT /v2/project/$apiKey/session/$sessionId |
| GET | `/v2/project/$api_key/archive` | GET /v2/project/$api_key/archive |
| POST | `/v2/project/$api_key/archive` | POST /v2/project/$api_key/archive |
| GET | `/v2/project/$api_key/archive/$archive` | GET /v2/project/$api_key/archive/$archive |
| DELETE | `/v2/project/$api_key/archive/$id` | DELETE /v2/project/$api_key/archive/$id |
| POST | `/v2/project/$api_key/archive/$id/stop` | POST /v2/project/$api_key/archive/$id/stop |
| GET | `/v2/project/$api_key/connect` | GET /v2/project/$api_key/connect |
| GET | `/v2/project/$api_key/dial` | GET /v2/project/$api_key/dial |
| GET | `/v2/project/$api_key/session/$session_id/stream` | GET /v2/project/$api_key/session/$session_id/stream |
| GET | `/v2/project/$api_key/session/$session_id/stream/$stream_id` | GET /v2/project/$api_key/session/$session_id/stream/$stream_id |
| PUT | `/v2/project/$partnerKey/archive/storage` | PUT /v2/project/$partnerKey/archive/storage |
| DELETE | `/v2/project/$projectKey/archive/storage` | DELETE /v2/project/$projectKey/archive/storage |
| GET | `/v2/project/${API_KEY}/session/${SESSION_ID}/connection` | GET /v2/project/${API_KEY}/session/${SESSION_ID}/connection |
| DELETE | `/v2/project/${API_KEY}/session/${SESSION_ID}/connection/${CONNECTION_ID}` | DELETE /v2/project/${API_KEY}/session/${SESSION_ID}/connection/${CONNECTION_ID} |
| POST | `/v2/project/${API_KEY}/session/${SESSION_ID}/connection/${CONNECTION_ID}/play-dtmf` | POST /v2/project/${API_KEY}/session/${SESSION_ID}/connection/${CONNECTION_ID}/play-dtmf |
| POST | `/v2/project/${API_KEY}/session/${SESSION_ID}/connection/${CONNECTION_ID}/signal` | POST /v2/project/${API_KEY}/session/${SESSION_ID}/connection/${CONNECTION_ID}/signal |
| POST | `/v2/project/${API_KEY}/session/${SESSION_ID}/migrate` | POST /v2/project/${API_KEY}/session/${SESSION_ID}/migrate |
| POST | `/v2/project/${API_KEY}/session/${SESSION_ID}/mute` | POST /v2/project/${API_KEY}/session/${SESSION_ID}/mute |
| POST | `/v2/project/${API_KEY}/session/${SESSION_ID}/play-dtmf` | POST /v2/project/${API_KEY}/session/${SESSION_ID}/play-dtmf |
| POST | `/v2/project/${API_KEY}/session/${SESSION_ID}/signal` | POST /v2/project/${API_KEY}/session/${SESSION_ID}/signal |
| POST | `/v2/project/${API_KEY}/session/${SESSION_ID}/stream/${STREAM_ID}/mute` | POST /v2/project/${API_KEY}/session/${SESSION_ID}/stream/${STREAM_ID}/mute |
| GET | `/v2/project/<apiKey>/render` | GET /v2/project/<apiKey>/render |
| POST | `/v2/project/<apiKey>/render` | POST /v2/project/<apiKey>/render |
| GET | `/v2/project/<apiKey>/render/&lt` | GET /v2/project/<apiKey>/render/&lt |
| DELETE | `/v2/project/<apiKey>/render/<experienceComposerId>` | DELETE /v2/project/<apiKey>/render/<experienceComposerId> |
| DELETE | `/v2/project/{apikey}` | DELETE /v2/project/{apiKey} |
| GET | `/v2/project/{apikey}` | GET /v2/project/{apiKey} |
| PUT | `/v2/project/{apikey}` | PUT /v2/project/{apiKey} |
| GET | `/v2/project/{apikey}/broadcast` | GET /v2/project/{apiKey}/broadcast |
| GET | `/v2/project/{apikey}/broadcast/{broadcastid}` | GET /v2/project/{apiKey}/broadcast/{broadcastId} |
| POST | `/v2/project/{apikey}/broadcast/{broadcastid}/stop` | POST /v2/project/{apiKey}/broadcast/{broadcastId}/stop |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/tokbox/openapi/_ae-authored/tokbox-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/tokbox/json-schema/tokbox-post-v2-project-api-key-archive-id-stop-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/tokbox/json-schema/tokbox-get-v2-project-lt-apikey-gt-render-lt-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/tokbox/json-schema/tokbox-post-v2-project-lt-apikey-gt-render-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/tokbox/json-schema/tokbox-post-v2-project-api-key-session-session-id-mute-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/tokbox/json-schema/tokbox-post-v2-project-apikey-broadcast-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/tokbox/json-schema/tokbox-get-graphql-response-schema.json
- **APIsJSON** — https://artifacts.apis.io/tokbox/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/tokbox/tokbox-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/tokbox/.