Search the documentation guides
Returns the sections of the guides that answer a question, best first, each with a snippet and a link to the heading it came from. This is the entry point: search, then read the one section you need rather than a whole page. A question the guides do not cover returns no results rather than the nearest paragraph.
- stringHeadererforderlich
Ihr API-Schlüssel.
Authorization: Bearer <key>wird ebenfalls akzeptiert.
- stringerforderlich
The question, in the words it would be asked in.
- Max. Länge
- 200
- Beispiel
- integerstandard
8How many sections to return.
- Bereich
- 1 – 25
- Beispiel
- object
The response payload.
- string
The question as it was asked.
- integer
How many sections matched, of which
resultscarries the best. - object[]
The matching sections, best first.
- string
The guide the section is on.
- string
That guide's title.
- string
The section's anchor.
- string
The heading.
- string
The heading with the ones above it.
- string
The page, opened at that heading.
- string
The opening of the section, so a caller can judge it without reading it.
- 400
VALIDATION_ERRORValidation error - 401
UNAUTHORIZEDAPI key required - 403
FORBIDDENValid key, not permitted - 429
RATE_LIMITEDRate limit exceeded - 500
INTERNAL_ERRORUnexpected server error
- Mindeststufe
- Explorer+
- Monatskontingent
- 200/mo
- Anfragerate
- 10/min
- Tageslimit
- 50
Die Werte gelten für die Mindeststufe dieses Endpunkts. Höhere Stufen erhöhen alle Limits.