Conversation Session

Create conversation session

Conversation tokens allow client-side applications to create a unique, authenticated credential for each conversation. This token can be used to interact with the conversation/{conversationId}/send, conversation/{conversationId}/receive, and conversation/{conversationId}/message/create routes. By creating an individual token for each conversation, a client-side application is able to directly access and manipulate the conversation through these routes. Without conversation tokens, a client-side application would need to authenticate and access conversation routes through a server-side application, which can be more complex and require additional infrastructure. By providing a way for client-side applications to authenticate and access the conversation routes directly, the token route simplifies the process of integrating with the API and makes it more convenient for developers to build AI applications.

post/conversation/{conversationId}/session/create

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/conversation/{conversationId}/session/create
  • Auth: HTTP bearer

Path parameters

conversationIdstring required

The ID of the conversation

Request body

durationInSecondsnumber

The maximum amount of time this session will stay open

Response

The session was created successfully

idstring required

The ID of the conversation

tokenstring required

The token for this conversation

expiresAtnumber required

The time the token will expire in milliseconds

Changes

No recorded changes to this operation across all 1 revision of this API.