Skip to main content
POST
/
v4
/
project
/
{projectID}
/
environment
/
{environmentID}
/
session
Start session
curl --request POST \
  --url https://general-runtime.voiceflow.com/v4/project/{projectID}/environment/{environmentID}/session \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "userID": "<string>"
}
'
{
  "sessionKey": "<string>"
}

Authorizations

​
authorization
string
header
required

Voiceflow API key

Path Parameters

​
projectID
string
required

ID of the target Voiceflow project.

​
environmentID
string
required

ID of the environment to target or an alias for the environment (ie. production or development).

Body

application/json
​
userID
string
required

Unique ID for the user.

Required string length: 1 - 256

Response

200 - application/json
​
sessionKey
string
required