Chat

Send new chat message and get response from your AI chat bot

application/json

Request Body required

Chat message request body

projectId uuid required

Your Magic AI project id

text string required

The text message that you want to send to your AI chat bot

sessionId string required

The unique identifier of the session. If you don't provide it, the API will generate a new session id for you. You will need to save this on your side for consecutive requests. Otherwise you will loose chat history

Responses

successful operation

application/json

Schema

Example (from schema)

Schema

text string

The response you get from your AI chat bot

sourceDocuments object[]

The documents that your AI chat bot used to generate the response

Array [

pageContent string

The text message that you want to send to your AI chat bot

metadata object

title string

The title of the datasource used to train the AI model

url string

If the datasource is a web page, this is the url of the page

]

{
  "text": "Magic AI is a SaaS platform that allows you to create personalized chat bots using your own data. It serves as a game-changing solution...",
  "sourceDocuments": [
    {
      "pageContent": "What is Magic AI?\\n\\nMagic AI is a SaaS platform that allows you to create personalised chat bots using your own data. The platform enables you to...",
      "metadata": {
        "title": "How Personalised Chat Bots Can Help Teams Work Together More Efficiently | Magic AI",
        "url": "https://magicai.ai/what-is-magic-ai"
      }
    }
  ]
}

The specified parameter is invalid

application/json

Schema

Example (from schema)

Schema

message string required

details string required

code string required

unique error code

{
  "message": "Invalid Request",
  "details": "Project already exists",
  "code": "PROJECT_EXISTS"
}

You don't have permission to access this resource

application/json

Schema

Example (from schema)

Schema

message string required

details string required

code string required

unique error code

{
  "message": "Invalid Request",
  "details": "Project already exists",
  "code": "PROJECT_EXISTS"
}

You need to upgrade your account to access this resource

application/json

Schema

Example (from schema)

Schema

message string required

details string required

code string required

unique error code

{
  "message": "Invalid Request",
  "details": "Project already exists",
  "code": "PROJECT_EXISTS"
}

An unexpected error occurred

application/json

Schema

Example (from schema)

Schema

message string required

details string required

code string required

unique error code

{
  "message": "Invalid Request",
  "details": "Project already exists",
  "code": "PROJECT_EXISTS"
}

Chat​

Chat