Developer API · Preview catalog

Preview tools

Discover the tools available to a Tellers preview experience, with one stable catalog for names, IDs, descriptions, and availability.

⌁

Keep preview keys private

Use a valid Tellers user/API credential or the preview key supplied for your environment. Send preview keys as X-Preview-Key headers from your server only.

Endpoints

GETcatalog

/preview/tool/list

List tools currently available to the preview catalog.

Configured tool setSettings visibilityActive date rulesEmail restrictions

import requests

BASE = "https://api.tellers.ai"
headers = {"X-Preview-Key": "your-preview-key"}

response = requests.get(f"{BASE}/preview/tool/list", headers=headers)
response.raise_for_status()

for tool in response.json():
    print(tool["id"], tool["name"])

GETlookup

/preview/tool/get

Fetch one available tool with tool_id. Returns 404 for unknown or unavailable IDs.

import requests

response = requests.get(
    "https://api.tellers.ai/preview/tool/get",
    params={"tool_id": "tool_id_here"},
    headers={"X-Preview-Key": "your-preview-key"},
)
response.raise_for_status()
tool = response.json()

Availability is evaluated at request time.Tools with an email allowlist or blocklist are omitted because preview requests have no user email context. Tools that are not active today are omitted too.

Response

[
  {
    "id": "tool_id_here",
    "name": "Tool name",
    "description": "What the tool does.",
    "deactivated": false
  }
]

idStable identifier used when selecting a tool.

nameHuman-readable display name.

descriptionHuman-readable summary.

deactivatedAlways false for returned tools; unavailable tools are omitted.