The live Xquik 'explore' tool searches the 120-route API catalog. This package stub returns setup guidance only.

When to use

• Call 'explore' before 'xquik' to find an endpoint, its parameters, and its response shape.

• Call it when the user asks what the Twitter API supports.

• Check whether an endpoint uses included usage or requires account access.

When not to use

• Use 'xquik' instead when fetching live X data.

• Skip discovery when you know the endpoint and parameters.

Behavior

• The live server searches the catalog without sending an API request.

• The package stub makes no network call and returns setup instructions.

• The live catalog has 120 routes. Of these, 119 support JSON or text.

• Each EndpointInfo contains method, path, summary, category, free, parameters, and responseShape.

Input format

Provide a bounded request function. Filter, search, or return the spec.endpoints EndpointInfo array.

Examples

Find all included-usage endpoints: async () => spec.endpoints.filter(e => e.free) Filter by category: async () => spec.endpoints.filter(e => e.category === 'composition') Search summaries: async () => spec.endpoints.filter(e => e.summary.toLowerCase().includes('tweet')) Get one endpoint: async () => spec.endpoints.find(e => e.path === '/api/v1/x/tweets/search')

The live 'xquik' tool sends approved requests across 120 catalog routes. This package stub returns setup guidance only.

When to use

• Call it after 'explore' identifies the endpoint and parameters.

• Use it for Twitter search, user lookup, draws, extractions, composition, private reads, monitors, webhooks, and approved writes.

• Get approval before private reads, persistent resources, metered operations, and writes.

When not to use

• Use 'explore' first when you do not know the endpoint.

• Omit API keys and authorization headers. The server adds authentication.

Behavior

• The live server processes xquik.request(path, options?) inside a bounded sandbox.

• The package stub makes no API request and returns setup instructions.

• The live tool cannot access local files or arbitrary network hosts.

• 119 catalog routes support JSON or text. Use REST for binary downloads.

• Write operations require prior approval and can return durable actions.

• Pagination responses include has_more and next_cursor. Pass cursor for the next page.

• Show the exact payload, target, and usage estimate before changing X or Xquik resources.

Error handling

• For 402, explain the account state and send the user to the dashboard.

• For 429, wait before retrying.

• For 404, explain which user, tweet, or monitor was not found.

• For durable writes, follow safe_to_retry and next_action before retrying.

Input format

Provide a bounded function that calls xquik.request(path, { method?, body?, query? }). The server adds authentication.

Examples

Search tweets: async () => xquik.request('/api/v1/x/tweets/search', { query: { q: 'twitter scraper api', limit: '50' } }) Get user: async () => xquik.request('/api/v1/x/users/elonmusk') Post after approval: async () => xquik.request('/api/v1/x/tweets', { method: 'POST', body: { account: '<confirmed_account>', text: '<confirmed_text>' } })