Skip to main content
POST
/
v4
/
project
/
{projectID}
/
environment
/
{environmentID}
/
session
Start session (specific environment)
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>"
}
The start session endpoint creates a new conversation session and returns a sessionKey. Use this key as your authentication credential when calling the Interact (stream) and Interact (non-stream) endpoints. Unlike the legacy interact endpoints, the new interact endpoints use a session key instead of an API key for authentication.

Authorizations

​
authorization
string
header
required

Voiceflow API key

Path Parameters

​
projectID
string
required

The ID of the target Voiceflow project. You can find it in the settings for your agent.

​
environmentID
string
required

The alias of the environment to target (ie. main). You can find this in the environments page of your agent.

Body

application/json
​
userID
string
required

Unique ID for the user. If a session already exists for this user, the existing session will end and a new session will be created with a new session key.

Required string length: 1 - 256

Response

200 - application/json
​
sessionKey
string
required

A session-scoped authentication key. Pass this as the authorization header when calling the interact endpoints.