Skip to main content
GET
ReadDoc

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

path
string
required

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

offset
integer<int32>

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

limit
integer<int32>

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

Response

A successful response.

path
string
read-only
title
string
read-only
totalLines
integer<int32>
read-only

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

startLine
integer<int32>
read-only

1-indexed line number of the first returned line.

content
string
read-only

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.