Knowledge bases

The knowledge bases (product facts, guidelines) available in your workspace.

Endpoints

GET /v1/infobase List knowledge bases
GET /v1/infobase/{id} Get a knowledge base

List knowledge bases

GET api.app.typetone.ai/public/v1/infobase

Authorization

X-API-Keyheaderrequired
Your workspace API key.

Response · 200

idstringrequired
Unique ID.
namestringrequired
Display name.
descriptionstring | null

Errors

401 Missing or invalid API key.
403 The workspace is not on a plan with API access.
404 The resource does not exist in this workspace.

curl "https://api.app.typetone.ai/public/v1/infobase" \
  -H "X-API-Key: $TYPETONE_API_KEY"

import os
import requests

response = requests.get(
    "https://api.app.typetone.ai/public/v1/infobase",
    headers={"X-API-Key": os.environ["TYPETONE_API_KEY"]},
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.app.typetone.ai/public/v1/infobase", {
  headers: {
    "X-API-Key": process.env.TYPETONE_API_KEY,
  },
});
const data = await response.json();

Response · 200

[
  {
    "id": "cmuf2k8x10001ab12cd34ef56",
    "name": "Homepage audit",
    "description": "Brand guidelines and product facts."
  }
]

Get a knowledge base

GET api.app.typetone.ai/public/v1/infobase/{id}

Authorization

X-API-Keyheaderrequired
Your workspace API key.

Path parameters

idstringrequired
Unique ID.

Response · 200

idstringrequired
Unique ID.
namestringrequired
Display name.
descriptionstring | null

Errors

401 Missing or invalid API key.
403 The workspace is not on a plan with API access.
404 The resource does not exist in this workspace.
422 A parameter or the request body is invalid. detail says which.

curl "https://api.app.typetone.ai/public/v1/infobase/cmuf2k8x10001ab12cd34ef56" \
  -H "X-API-Key: $TYPETONE_API_KEY"

import os
import requests

response = requests.get(
    "https://api.app.typetone.ai/public/v1/infobase/cmuf2k8x10001ab12cd34ef56",
    headers={"X-API-Key": os.environ["TYPETONE_API_KEY"]},
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.app.typetone.ai/public/v1/infobase/cmuf2k8x10001ab12cd34ef56", {
  headers: {
    "X-API-Key": process.env.TYPETONE_API_KEY,
  },
});
const data = await response.json();

Response · 200

{
  "id": "cmuf2k8x10001ab12cd34ef56",
  "name": "Homepage audit",
  "description": "Brand guidelines and product facts."
}

Something unclear or missing? Tell us and we'll improve this page.