Sign in

v1

latestOpenAPI 3.0.02026-07-2251509353.3 KB
Session
Public-Docs

Start session (specific environment)

Start a new conversation and get a session key for interacting with an agent in a specified environment.

post/v4/project/{projectID}/environment/{environmentID}/session

Path parameters

projectIDstring required

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

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

environmentIDstring required

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

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

Request body

userIDstring 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.

Response

sessionKeystring required

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