API Reference

The platform API

Four groups of operations: asking a question against the indexed content, with or without streaming; the widget configuration; handing a conversation to a human; and getting documents into the index. Every path listed here was called against the live host before it was published.

openapi.json Quick start guide

Base URL and authentication

Base URL

https://api.slatech.ai

The paths themselves carry the /v1.

Authentication

A key in its own header, not a Bearer token:

X-Api-Key: <API_KEY>

Sending Authorization: Bearer instead returns 401. The key resolves to a client and a site, and those decide what the request can see.

Version

OpenAPI 3.0.3, API version 1.0.0. This file is hand-written, so every path in it was called against the live host before publication: anything that answered 404 is not here.

Endpoints

MethodPathWhat it does
POST/v1/queryOne question, the complete answer. question is required, 2,000 characters maximum.
POST/v1/query/streamSame request body; the answer arrives as it is produced.
PATCH/v1/query/{id}/feedbackRecord whether an answer was useful.
GET/v1/widget-configWidget settings for the key presented.
GET/v1/suggested-questionsOpening questions to offer the visitor.
GET/v1/visitor-historyEarlier turns for a returning visitor.
POST/v1/handoffHand the conversation to a human. email is required.
POST/v1/ingest/urlIndex the content at a URL.
POST/v1/ingest/sitemapIndex every URL in a sitemap.
POST/v1/ingest/textIndex a block of text supplied directly.
DELETE/v1/documents/{documentId}Remove a document from the index.
GET/healthPlatform status. Open, no key needed.

Your first request

Send a message and get a reply, no SDK required:

curl -X POST https://api.slatech.ai/v1/query \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"What are your opening hours?","topK":5}'

Without a valid key the call returns 401; with a malformed body, 400. topK runs 1 to 20 and defaults to 5.

What the spec does not cover

The public specification covers querying, widget configuration, handoff and ingestion. Webhooks and custom actions are not part of it: they are built per integration, around the systems being connected. If you need them, that is part of the scoping conversation. We do not list an endpoint here that has not been called against the live host.

What we connect to Talk to us