DocsService

ReadDoc

Read the full markdown of a Sift documentation page by path.

get/api/v1/docs:read

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/docs:read
  • Auth: HTTP bearer

Query parameters

pathstring required

Doc path returned by SearchDocs, e.g. "documentation/ingest/asset-channels.mdx". Required.

offsetinteger

1-indexed start line. Defaults to 1. Optional.

limitinteger

Number of lines to return. Defaults to all remaining lines. Optional.

Response

A successful response.

pathstring
titlestring
totalLinesinteger

Total line count of the page (independent of offset/limit).

startLineinteger

1-indexed line number of the first returned line.

contentstring

Page markdown. Each line is prefixed with "{line_number}\t" so follow-up reads can target specific ranges. MDX/JSX tags are stripped; fenced code blocks are preserved.

Changes

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