chatbot

Get Multimodal Chat Response

Changed on

Multimodal chat response endpoint.

It can be used to support engaging conversations with both text and image responses.

For usage examples, see: https://docs.exh.ai/recipes/multimodal-chat

post/chatbot/v3/response

Request

  • Base URL
    https://api.exh.ai
  • URL
    https://api.exh.ai/chatbot/v3/response
  • Auth
    HTTP bearer

Headers

X-Request-Idstring

Request body

Example request

{
  "context": [
    {
      "image_prompt": "Man in the mountains",
      "message": "Hi, how are you?",
      "turn": "bot"
    },
    {
      "message": "I'm fine, thanks. How is it going with you?",
      "turn": "user"
    }
  ],
  "bot_profile": {
    "id": "1234567890",
    "name": "Sam",
    "description": "I'm a big fan of AI.",
    "appearance": "39 yo, white, short black hair, slim",
    "example_messages": [
      "Hey, what's up?"
    ]
  },
  "user_profile": {
    "id": "1234567890",
    "name": "Sam"
  },
  "chat_settings": {
    "tasks": [
      "You must never mention anything related to cryptocurrency.",
      "Use emojis in responses.",
      "Suggest user to buy subscription, if it fits in the context.",
      "Say user that photo's will not be provided."
    ]
  },
  "image_settings": {
    "identity_image_url": "https://exh-data.s3.us-west-2.amazonaws.com/cv/default_bots_metadata/v3/Elon%20Musk/avatar_256.jpg"
  }
}

Response

Successful Response

responsestring required

Changes

    • breaking

      for the header request parameter X-Request-Id, default value was changed from 37ecffb7-c947-489d-8e7c-b7bf10be38e3 to a4993898-7ea1-4598-baf4-193c64bb5f0e

    • breaking

      for the header request parameter X-Request-Id, default value was changed from 1150514a-4de8-4fb7-baa7-e6c2ea20a43b to 37ecffb7-c947-489d-8e7c-b7bf10be38e3