Documentation

Get one documentation page

One documentation page as markdown, with its title, description, and last update date. The slug is the path after /docs/ — for example 'quickstart', 'agent-mode', or 'privacy-model'. On a miss the 404 detail suggests the nearest slug, so a typo costs one request rather than a guessing game.

get/docs/{slug}

Request

  • Base URL: https://yappy.biz/api/v1
  • URL: https://yappy.biz/api/v1/docs/{slug}
  • 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)

Path parameters

slug'quickstart' | 'dictation' | 'agent-mode' | 'backends' | 'configuration' | 'privacy-model' | 'troubleshooting' | 'changelog' required

Documentation page slug — the path after /docs/.

Response

The requested documentation page

object'doc' required

Type discriminator.

slugstring required

Path after /docs/.

titlestring required

Page title.

descriptionstring required

One-line summary.

urlstring uri required

HTML page.

markdown_urlstring uri required

Markdown twin.

contentstring required

The page body as markdown.

word_countinteger

Length of the body in words.

last_updatedstring date

When the page last changed.

sandboxboolean

Present and true on sandbox fixtures.

Changes

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