Docs

Start here

What you can write in about

GET/v1/support/topicson https://api.auray.ai/v1

Rows rather than a list compiled into a form, so adding a topic is a routing decision made once rather than a deploy of every surface that renders it.

Rows rather than a list compiled into a form, so adding a topic is a routing decision made once rather than a deploy of every surface that renders it. Each carries the answer /help prints for it, and where to read more; the answer is null for a topic that has none yet. Cached at the edge for five minutes with an hour of stale service. It answers while intake is closed or not configured, because the answers are read on their own; whether a request would be taken is accepting_requests on GET /v1/status.

#Authentication

No key needed — this document is public.

#Example request

curl https://api.auray.ai/v1/support/topics

#Responses

#200 OK

OK

FieldTypeRequiredDefaultDescription
topicsobject[]no—
topics[].idstringno—
topics[].titlestringno—
topics[].descriptionstringno—
topics[].answerstringno—The answer /help prints for this topic, written by support. {error_codes} stands for the number of documented error codes. May be null.
topics[].linkobjectno—Where to read more. href is a path on auray.ai, or {app}/… for a page of the desktop app. May be null.
topics[].link.hrefstringno—
topics[].link.labelstringno—

Headers:

HeaderDescription
Cache-Controlpublic, s-maxage=300, stale-while-revalidate=3600.
X-Request-Id

#503 Service Unavailable

support_disabled — the support surface has been switched off — or support_unavailable.

The error body: error, message, docs (the entry that explains it) and request_id.

#Status codes

StatusMeaning
200OK
503support_disabled — the support surface has been switched off — or support_unavailable.

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close