POST: Conversation ID

POST: Conversation ID

API URL: https://platform.blits.ai/api/external/initialize

With this POST request a new conversation ID is created. The conversation ID is used to interact with the chatbot. The conversation ID is needed for the other APIs to return information such as:

  • Type of prior block


  • Type of following block


  • Content of the user message


  • Content of the bot response.

The conversation id is used to chat with the bot.

Authorization

To set this up, the above API URL is need together with the authorization header. The header should have the following format:

Bearer <key>

The key can be obtained from the API settings on the settings page of your bot under the JSON Web Token:

Body

The body of this POST call remains empty

Response

The POST response should look like the following:

{
    "conversationId": "5d2d3475-1206-460d-888a-1c298a457090"
    • Related Articles

    • POST: Send Voice

      API URL: https://platform.blits.ai/api/external/messages/<YOUR_CONVERSATION_ID>/speech With this POST request a message can be send to the bot. Please follow the following steps to do so. Conversation ID This is the output of the POST Conversation ID ...
    • POST: Send file

      API URL: https://platform.blits.ai/api/external/messages/<YOUR_CONVERSATION_ID>/text With this POST request a message can be send to the bot. This API only works if the bot is expecting a file. Please follow the following steps to execute the API. ...
    • POST: Send Message

      API URL: https://platform.blits.ai/api/external/messages/<YOUR_CONVERSATION_ID>/text With this POST request a message can be send to the bot. Please follow the following steps to do so. Conversation ID This is the output of the POST Conversation ID ...
    • Send conversation history

      The send conversation history block enables you to send the conversation log to an email.
    • Tutorial 4 - Build your basic conversation