Search API

Use the search API to run the same semantic search your bot uses when it answers, from your own code. You send a question and get back the most relevant passages from the bot's data sources, best match first. Each passage tells you which data source row it came from, such as a Notion page, a web page or a file, so you can match it to your own records.

Search covers every type of data source on the bot, not only manual ones. It only finds content that has finished syncing.

Each channel can search 120 times a minute. Searches don't use message tokens.

Search a bot's knowledge

POST https://app.chatthing.ai/api/public/channels/{channelId}/2.0/search

It also works with 1.0 in place of 2.0. Every request needs these headers:

Content-Type: application/json
X-API-Secret-Key: {secretKey}

curl --request POST \
  --url https://app.chatthing.ai/api/public/channels/{channelId}/2.0/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Secret-Key: {secretKey}' \
  --data '{"query": "How do I reset my password?", "limit": 5}'

const response = await fetch(
  `https://app.chatthing.ai/api/public/channels/${channelId}/2.0/search`,
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "X-API-Secret-Key": secretKey,
    },
    body: JSON.stringify({ query: "How do I reset my password?", limit: 5 }),
  },
);
const { results } = await response.json();

import requests

url = f"https://app.chatthing.ai/api/public/channels/{channel_id}/2.0/search"
headers = {
    "Content-Type": "application/json",
    "X-API-Secret-Key": secret_key,
}

response = requests.post(
    url, headers=headers, json={"query": "How do I reset my password?", "limit": 5}
)
results = response.json()["results"]

{
  "success": true,
  "results": [
    {
      "id": "7f0c1d52-3c2e-4f0e-9a51-9d2b8f3c6a10",
      "content": "To reset your password, open Settings and choose Security...",
      "meta": {
        "url": "https://example.com/help/reset-password",
        "title": "Reset your password"
      },
      "similarity": 0.89,
      "rank": 1,
      "source": {
        "dataSourceId": "41559b21-b8ff-44c3-8658-1c9e34273070",
        "dataSourceRowId": "0b9d3a77-5d0e-4c1f-8f4e-2f6a1c9e8b33",
        "parentDataSourceRowId": null,
        "type": "WEB",
        "config": {
          "url": "https://example.com/help/reset-password"
        }
      }
    }
  ]
}

The result object

Long documents are split into several passages, so more than one result can share the same source.

The source object

The config fields for each type:

Errors