Search

Perform search on your data sources.

application/json

Request Body required

Chat message request body

projectId uuid required

Your Magic AI project id

query string required

your search query to perform against your data sources

Responses

• 200
• 400
• 401
• 403
• 426
• 500

---

successful operation

application/json

Schema

Example (from schema)

---

Schema

• 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

• ]

[
  {
    "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"
}

Authentication information is missing or invalid

Response Headers

• WWW_Authenticate string

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"
}

Loading...