Endpoint
GET
/v1/stable/persona

List all personas by project ID.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json
personas
object[]
required
StablePersona — see its attributes above
Endpoint
POST
/v1/stable/persona

Create a new persona.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

name
string
required

The name of the persona. Must not already be used by another persona in this environment.

Minimum length: 1 · Maximum length: 255
items
object[]

The variable values this persona presets. On update this replaces the whole list: send every item the persona should keep. An item read back with a null variable cannot be kept: leave it out, or name an existing variable in its place.

StablePersonaItemInput — see its attributes above

Response

201 - application/json
persona
object
required
StablePersona — see its attributes above
Endpoint
GET
/v1/stable/persona/{personaID}

Get a persona by ID.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

personaID
string
required

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json
persona
object
required
StablePersona — see its attributes above
Endpoint
PATCH
/v1/stable/persona/{personaID}

Update a persona by ID.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

personaID
string
required

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

name
string

The name of the persona. Must not already be used by another persona in this environment.

Minimum length: 1 · Maximum length: 255
items
object[]

The variable values this persona presets. On update this replaces the whole list: send every item the persona should keep. An item read back with a null variable cannot be kept: leave it out, or name an existing variable in its place.

StablePersonaItemInput — see its attributes above

Response

200 - application/json
message
string
required

A human-readable message confirming the update.

Endpoint
DELETE
/v1/stable/persona/{personaID}

Delete a persona by ID.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

personaID
string
required

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json
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.