Tra cứu API

Đọc một trang tài liệu X-Buddy

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

docs_read · Đọc dữ liệu đã lưu

Mô tả kỹ thuật bằng tiếng Anh — đúng chữ AI agent đọc qua MCP.

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`
Công cụ MCP	`docs_read`
Quyền cần có	`view` — Chủ, Quản lý, Vận hành, Chỉ xem
Nhóm quyền	`accounts:read`
Nhóm	Gọi gián tiếp và tài liệu
Hiện sẵn trong hồ sơ	mọi hồ sơ (bộ lõi)

Đầu vào

Trường	Kiểu	Bắt buộc	Mô tả
`page`	string (1–200 chars)	Có	Page slug from docs_search (e.g. 'troubleshooting', 'reference/post_create') or a full docs URL.
`locale`	`en` · `vi`	Không	Docs language: en (default) or vi.
`section`	string (0–80 chars)	Không	Optional heading anchor (from docs_search) to return only that section.

Kết quả

Trả về trong phong bì { data, meta }, không tạo việc trên X. Danh sách có next_cursor và has_more.

Ví dụ

Gọi qua REST

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

Gọi qua MCP

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

Lỗi có thể gặp

Mã	HTTP	Thử lại được
`unauthorized`	401	Không
`key_expired`	401	Không
`integration_revoked`	401	Không
`connection_not_linked`	403	Không
`integration_paused`	403	Không
`workspace_integrations_paused`	403	Không
`integration_authorization_lost`	403	Không
`workspace_suspended`	403	Không
`forbidden`	403	Không
`invalid_input`	422	Không
`rate_limited`	429	Có
`internal`	500	Có

Về danh sách thao tác

Đọc một trang tài liệu X-Buddy

#Đầu vào

#Kết quả

#Ví dụ

#Gọi qua REST

#Gọi qua MCP