explore
:
Instructions
Search and browse the Xquik X (Twitter) API specification to discover endpoints before making live API calls with the 'xquik' tool.
When to use
Use 'explore' FIRST to find the right endpoint path, parameters, and response shape before calling 'xquik'.
Use when the user asks what capabilities are available or how to accomplish a task on X/Twitter.
Use to check whether an endpoint is free or requires a subscription.
When NOT to use
Do NOT use 'explore' to fetch live data from X — use 'xquik' instead.
Do NOT use if you already know the endpoint path and parameters.
Behavior
Read-only, idempotent. No network calls — runs against an in-memory catalog of 121 endpoints.
Always free, no authentication or credits required.
Returns the result of your filter function (e.g., empty array if no endpoints match).
Returns an error message if the code is syntactically invalid or throws at runtime.
Execution timeout: 60 seconds.
Each EndpointInfo contains: method, path, summary, category (account | composition | credits | extraction | integrations | media | monitoring | support | twitter | x-accounts | x-write | bot), free (boolean), parameters (array), and responseShape (string).
Input format
Write an async arrow function. The sandbox provides spec.endpoints (EndpointInfo[]). Filter, search, or return them.
Examples
Find all free endpoints: async () => spec.endpoints.filter(e => e.free)
Find by category: async () => spec.endpoints.filter(e => e.category === 'composition')
Search by keyword: async () => spec.endpoints.filter(e => e.summary.toLowerCase().includes('tweet'))
Get full details: async () => spec.endpoints.find(e => e.path === '/api/v1/x/tweets/search')
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | JavaScript async arrow function that filters or searches spec.endpoints (EndpointInfo[]). Must return an array or single EndpointInfo object. Example: async () => spec.endpoints.filter(e => e.category === 'twitter') |