Skip to content
X-Buddy
Tiếng Việt

API reference

Read an X-Buddy docs page

docs_read — Read one public X-Buddy docs page as Markdown: a guide (e.g.

Markdown version

docs_read · Reads saved data

Read one public X-Buddy docs page as Markdown: a guide (e.g. 'limits-and-safety'), an operation reference ('reference/x_follow') or an error code ('errors/revision_conflict'). Pass a section anchor from docs_search to get only that part. Returns the page title, URL, its sections and the Markdown.
REST GET /api/public/v1/docs/page
MCP tool docs_read
Permission needed view — Owner, Manager, Operator, Viewer
Scope group accounts:read
Group Indirect calls and docs
Shown up front in profiles every profile (core set)

Input

Field Type Required Description
page string (1–200 chars) Yes Page slug from docs_search (e.g. 'troubleshooting', 'reference/post_create') or a full docs URL.
locale en · vi No Docs language: en (default) or vi.
section string (0–80 chars) No Optional heading anchor (from docs_search) to return only that section.

Result

Returned in the { data, meta } envelope, without creating a job on X. Lists include next_cursor and has_more.

Example

Call over REST

curl -X GET "https://reach-link-craft.lovable.app/api/public/v1/docs/page?page=example" \
  -H "Authorization: Bearer $XBUDDY_API_KEY"

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "docs_read",
    "arguments": {
      "page": "example"
    }
  }
}

Errors you may get

Code HTTP Retryable
unauthorized 401 No
key_expired 401 No
integration_revoked 401 No
connection_not_linked 403 No
integration_paused 403 No
workspace_integrations_paused 403 No
integration_authorization_lost 403 No
workspace_suspended 403 No
forbidden 403 No
invalid_input 422 No
rate_limited 429 Yes
internal 500 Yes

Back to all operations