Sign in

v1

latestOpenAPI 3.0.02026-07-2251509353.3 KB
Session
Public-Docs

Start session (with traffic split)

Start a new conversation and get a session key for interacting with an agent, routing traffic based on its traffic split.

post/v4/project/{projectID}/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.

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.