Workspaces, projects, and tokens - Voiceflow Documentation

Workspaces and projects are the containers everything else sits inside. Getting a projectID starts here, and so does understanding how far a single token reaches.

The hierarchy

An organization contains workspaces. A workspace contains projects. A project owns exactly one agent, along with its playbooks, tools, variables, knowledge base and environments. Most other endpoints in this API take a projectID, which you get by listing the projects in a workspace:

curl "https://realtime-api.voiceflow.com/v1/stable/project?workspaceID=$VF_WORKSPACE_ID" \
  -H "Authorization: Bearer $VF_PAT"

What a token can see

A personal access token carries your own access. Listing workspaces returns every workspace your account belongs to, not a subset scoped to the integration, so a script that iterates workspaces will reach further than you might expect. Pin the IDs you mean to operate on rather than discovering them at runtime.

Deleting

Deleting a project removes the agent and everything in it, including transcripts. Deleting a workspace removes every project inside it. Neither is recoverable through the API.

Where to go next

With a project in hand, build its agent and ship it through environments.