Endpoint
GET
/v1/stable/project

Returns every project in the workspace. A project is the container that owns exactly one agent. The call takes no paging parameters, so one request yields the whole set.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

workspaceID
string
required

The ID of the workspace to list projects from.

Response

200 - application/json

Returns every project in the workspace named by workspaceID, each with its name, description, image URL, and creation and update timestamps.

projects
object[]
required
StableProject — see its attributes above
Endpoint
POST
/v1/stable/project

Adds a project to the workspace, the container that owns exactly one agent. The response carries the ID that later calls address it by.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Request body

name
string
required
workspaceID
string
required

The ID of the workspace the project belongs to.

type
enum<string>
required

The channel type of the project to create.

Available options: webchat, phone-call

Response

201 - application/json

Creates the project and returns it, including the ID that most other endpoints take as their projectID query parameter.

project
object
required
StableProject — see its attributes above
Endpoint
GET
/v1/stable/project/{projectID}

Returns a single project by ID, with the fields that define it. A project is the container that owns exactly one agent.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

Returns the one project, with its name, description, image URL, and the workspace that holds it.

project
object
required
StableProject — see its attributes above
Endpoint
PATCH
/v1/stable/project/{projectID}

Changes an existing project in place. The response carries only a confirmation message, so refetch the project to read its new values.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

name
string

Response

200 - application/json

Confirms the change to the project was saved. The response carries a message rather than the project, so read the project back to see its current name and description.

message
string
required

A human-readable message confirming the update.

Endpoint
DELETE
/v1/stable/project/{projectID}

Deletes a single project by ID. A project is the container that owns exactly one agent. The response carries only a confirmation message, so refetch the projects to see what is left.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

Confirms the project was deleted. The response is a message only, so list the workspace's projects again if you keep your own copy of them.

message
string
required

A human-readable message confirming the deletion.

Schemas

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.