Tra cứu API

Tìm trong tài liệu X-Buddy

docs_search — Search the public X-Buddy documentation — user guides, limits and safety, troubleshooting, the API reference and error codes — in English or Vietnamese.

Bản Markdown

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

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

Search the public X-Buddy documentation — user guides, limits and safety, troubleshooting, the API reference and error codes — in English or Vietnamese. Returns up to 10 pages with the best matching section and a snippet; read one with docs_read. The docs explain how X-Buddy behaves; they never contain workspace data.


REST	`GET /api/public/v1/docs/search`
Công cụ MCP	`docs_search`
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ả
`query`	string (2–200 chars)	Có	What you want to know, e.g. 'why is my job held', 'rolling 7-day limit', 'verify webhook signature'.
`locale`	`en` · `vi`	Không	Docs language: en (default) or vi.
`limit`	integer (1–10)	Không	How many pages (default 5, max 10).

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/search?query=ai+agents" \
  -H "Authorization: Bearer $XBUDDY_API_KEY"

Gọi qua MCP

{
  "method": "tools/call",
  "params": {
    "name": "docs_search",
    "arguments": {
      "query": "ai agents"
    }
  }
}

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

Tìm trong tài liệu X-Buddy

#Đầu vào

#Kết quả

#Ví dụ

#Gọi qua REST

#Gọi qua MCP