Documentation

Search documentation and FAQ

Full-text search across every documentation page and FAQ entry. Results carry a relevance score, the matching excerpt, and both HTML and markdown URLs, so you can quote the excerpt and cite the page in one step. Cursor-paginated.

get/search

Request

  • Base URL: https://yappy.biz/api/v1
  • URL: https://yappy.biz/api/v1/search
  • Auth: one of:
    • none
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://yappy.biz/oauth/authorize, token URL https://yappy.biz/oauth/token; client credentials, token URL https://yappy.biz/oauth/token, scopes: read:docs)

Query parameters

qstring required

What to search for, in plain words.

limitinteger

How many results to return, 1 to 50.

cursorstring

Opaque cursor from a previous response's pagination.next_cursor. Pass it back verbatim; do not construct one.

type'doc' | 'faq'

Narrow the search to one kind of result.

Response

Ranked search results

object'list' required

Type discriminator.

querystring required

The query that produced these results.

totalinteger

How many results matched in total.

Changes

No recorded changes to this operation across all 1 revision of this API.