API reference

Search the X-Buddy docs

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

Markdown version

docs_search · Reads saved data

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`
MCP tool	`docs_search`
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
`query`	string (2–200 chars)	Yes	What you want to know, e.g. 'why is my job held', 'rolling 7-day limit', 'verify webhook signature'.
`locale`	`en` · `vi`	No	Docs language: en (default) or vi.
`limit`	integer (1–10)	No	How many pages (default 5, max 10).

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

Call over MCP

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

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

Search the X-Buddy docs

#Input

#Result

#Example

#Call over REST

#Call over MCP