Ask, answers from your docs
Open in
Ask answers a reader's question from your product's own docs, cites each page it used, and says so when no page answers.
Filled: what the reader sees. Each question is kept, answered or not.
An answer, line by line
A Customer's agent asks over the docs MCP why a lookup cost nothing, and gets this.
HTTP/1.1 200 OK
Content-Type:| Field | What it holds |
|---|---|
answer | At most 120 words, each sentence backed by a citation; a sentence no page supports is dropped before the answer leaves |
citations | Up to 8 pages and sections, each at the Version the reader calls |
answered | false when no page answers; then reason says why and results holds the search results |
handoff | With handoff on, the link that opens a help request with the question attached |
A price is never paraphrased: it prints from the Offer, as the reference does.
Where a reader asks
| Who asks | Where | What comes back |
|---|---|---|
| A developer reading the docs | The search box, under the results | The answer, each sentence linked to its section |
| A Customer's agent | ask on the docs MCP at / | The answer as text, with citations and version as data |
| A member in the portal | The help page, before a help request | The answer, then a button that opens the request with the question attached |
With signedIn, Ask also reads a signed-in reader's own plan and usage, for questions such as "how many calls are left".
When Ask does not answer
Ask never acts, never reads another Customer's records, and never charges the reader. Each way it declines says why.
| The case | The reader gets |
|---|---|
| No page supports an answer | answered:, reason:, the search results, and the help link when handoff is on |
| A question about another Customer, or one that asks Ask to act or spend | answered:, reason:, and the Verb's docs page when one does what was asked |
| Text in the question that tries to instruct Ask | Read as words to search, never as an order, as untrusted text is everywhere |
| A usage question from a reader who is not signed in | The docs' answer alone, with reason: and the sign-in link |
| The reader's questions for the day are spent | 429 ask_limited, with Retry-After and the search results in results |
| Your AI allowance is spent and your spend cap holds | 503 ask_paused, with the search results; search never stops |
| A question over 500 characters | 400 invalid_param, naming the limit |
| The model behind Ask does not answer in 20 seconds | answered:, reason:, and the search results |
Every question is kept, answered or not, with Question.list on the Operator plane. An unanswered one joins the unmet asks your product reports on its life.
Thirty questions a day
The lookup by domain answers 30 questions a reader a day, and hands the rest to a person.
import { define, secret } from 'apis.dev'
/** Any company by its domain,How much a reader may ask
| What | How much |
|---|---|
| Questions a reader asks each day | day, from 1 to 500; 20 when the file names none |
| A question | 500 characters |
| An answer | 120 words and 8 citations |
| Languages | The reader's locale where the docs are written in it; else the docs' first locale, said so in the answer |
| Kept | Every question and answer, 400 days, then cold with the rest of the product's history |
| Who pays | Your AI allowance; a reader never pays for a question. Ask is a Launch feature |
Support for your Customers
Help requests on every channel with the calls attached, response promises per plan, a person one step away, and a help centre generated with the docs.
Lead capture and the interest list
Forms on the generated site, and a tool for agents, that turn a visitor into a contact: confirmed, enriched at its price, synced to your CRM, kept with consent.