Documentation endpoints

The platform API also serves the Docs tab: the documentation's contents list, single pages fetched by id, and an ask endpoint that answers questions about DataMind as a stream. All three use the same base URL and company API key as the rest of the platform API; see Use the API.

The endpoints

All three require the x-api-key header, like every other call to the platform API.

Endpoint	What it returns
`GET /llm/documentation/content`	The contents list of the documentation.
`GET /llm/documentation/content/page/<pageId>`	One page of the documentation, fetched by id.
`GET /llm/documentation/ask/stream`	An answer to a question, streamed as server-sent events.

Read the contents list

bash

curl https://platform.datamind.ai/llm/documentation/content \
  -H "x-api-key: $DATAMIND_API_KEY"

The response is the documentation service's own payload, passed through unchanged. The endpoint forwards the query parameters you send with the request: a value is forwarded as a string, and a parameter sent as an array is forwarded as its first item.

Fetch a page by id

Take a pageId from the contents list and fetch that page:

bash

curl "https://platform.datamind.ai/llm/documentation/content/page/<pageId>" \
  -H "x-api-key: $DATAMIND_API_KEY"

The page passes through unchanged as well. If the documentation service answers with an error, its status and body come back as they are.

Ask a question

GET /llm/documentation/ask/stream answers a question about DataMind. Send the question in query:

bash

curl -G https://platform.datamind.ai/llm/documentation/ask/stream \
  -H "x-api-key: $DATAMIND_API_KEY" \
  --data-urlencode "query=How do I create an API key?"

query is required. A request without it is refused with 'query' is required.
query is at most 500 characters. A longer one is refused with 'query' must be at most 500 characters.

The answer arrives as server-sent events. If the stream breaks after it starts, the last event is event: error with the message Documentation stream interrupted; send the ask again. If you close the connection, the answer stops.

What these calls cost

Nothing. The documentation endpoints are unmetered by design: they write no usage rows, nothing is billed, and the platform's limits do not gate them. The Docs tab keeps working when your company's AI budget is spent. Your API key still has to be valid.

Personal data and the ask

If your company turns on Prohibit PII transmission in Settings, the ask is checked before it is forwarded. A query that carries personal data is refused with status 400 and code content_filter, and it never reaches the documentation service. The option is described in full on Prohibit PII transmission.

Refusals

These are the refusals these endpoints produce; the full lists of statuses and codes are on Errors and retries.

When	What you get
The ask has no `query`	Status 400, code `invalid_request`, message `'query' is required`.
`query` is longer than 500 characters	Status 400, code `invalid_request`, message `'query' must be at most 500 characters`.
An ask carries personal data while the block is on	Status 400, code `content_filter`; the ask is not forwarded.
The documentation service is not available right now	Status 503, code `service_unavailable`; try again shortly.
The documentation service cannot be reached, or does not answer in time	Status 502, code `upstream_unavailable`, or status 504, code `upstream_timeout`.

Questions, answered

Which endpoints back the Docs tab?

Three: GET /llm/documentation/content lists the contents, GET /llm/documentation/content/page/<pageId> fetches one page by id, and GET /llm/documentation/ask/stream answers a question as a stream.

Do the documentation calls use my AI budget?

No. The documentation endpoints are unmetered by design: they write no usage rows, nothing is billed, and the platform's limits do not gate them. The Docs tab keeps working when your company's AI budget is spent. Your API key still has to be valid.

How long can an ask query be?

At most 500 characters. A request without query is refused with 'query' is required; a longer one is refused with 'query' must be at most 500 characters.

Can I send query parameters with the content calls?

Yes; the endpoints forward them to the documentation service, so the service's own options work with the call. A value is forwarded as a string, and an array parameter as its first item.

What happens if the ask stream is interrupted?

The answer stops, and the last event is event: error with the message Documentation stream interrupted. Send the ask again.

Why do the documentation endpoints answer 503?

The documentation service is not available right now: it is briefly down, or documentation is not configured on your deployment. Try again shortly; the rest of the platform API keeps working.

Do the documentation endpoints need authentication?

Yes. They use the same company API key as the rest of the platform API, sent in the x-api-key header; see Use the API. An Administrator manages the key in Settings.

Does the personal-data block cover the documentation ask?

Yes. With Prohibit PII transmission on, the ask is checked before it is forwarded, and a query with personal data fails with status 400 and code content_filter. The option is described on Prohibit PII transmission.