Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xquik.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this page when an AI agent needs to choose the right Xquik surface, call live X data, hand results to a backend, or recover missed webhook work. Keep the agent’s live calls narrow, persist cursor state, and move long-running jobs to REST, SDKs, or webhooks.

Pick the Agent Surface

Docs MCP

Use https://docs.xquik.com/mcp when the agent needs public docs, API reference pages, examples, troubleshooting, or type definitions. It is read-only and requires no auth.

API MCP

Use https://xquik.com/mcp when the agent needs account actions, live X reads, extraction jobs, monitors, webhooks, or writes. It requires x-api-key or OAuth 2.1.

REST or SDK

Use REST or generated SDKs when a service owns retries, cursor storage, file downloads, queues, or batch jobs outside the chat session.

Webhooks and Replay

Use monitor webhooks for fresh events and GET /api/v1/events when a receiver, queue, warehouse, or agent run needs replay.

Default Agent Route

  1. Search public docs or llms.txt for the workflow before calling live data.
  2. Use explore before xquik.request(...) to confirm the endpoint path, required parameters, costs, and response shape.
  3. Call xquik.request(path, { method?, body?, query? }) with the smallest useful page size.
  4. Return normalized rows, IDs, has_more, and next_cursor instead of full raw pages.
  5. Hand long-running or replayable work to REST, SDKs, webhooks, or exports.
async () => {
  const matches = spec.endpoints.filter((endpoint) =>
    endpoint.path.includes('/x/tweets/search') ||
    endpoint.summary.toLowerCase().includes('followers')
  );

  return matches.map(({ method, path, summary, parameters, responseShape }) => ({
    method,
    path,
    summary,
    parameters,
    responseShape
  }));
}

Call With Stored Rows

MCP returns normalized snake_case fields. Keep agents on has_more and next_cursor even when REST or SDK pages show camelCase response fields.
async () => {
  const query = 'from:xquikcom MCP';
  const page = await xquik.request('/api/v1/x/tweets/search', {
    query: { q: query, limit: '50' }
  });

  return {
    source: 'xquik_mcp',
    job: 'tweet_search',
    query,
    rows: page.tweets.map((tweet) => ({
      tweet_id: tweet.id,
      text: tweet.text ?? null,
      author_id: tweet.author?.id ?? null,
      author_username: tweet.author?.username ?? null,
      created_at: tweet['created'] ?? null,
      url: tweet.url ?? null
    })),
    has_more: page.has_more,
    next_cursor: page.next_cursor
  };
}

Cursor Rules

SourceNext request
MCP X data pagesPass next_cursor back as cursor when has_more is true.
MCP /api/v1/draws, /api/v1/extractions, /api/v1/events, and /api/v1/radarPass next_cursor back as after.
REST and generated SDKsFollow the response fields documented on that endpoint page.
Check GET /api/v1/credits before large reads. Low credit balances can return smaller pages, and zero affordable rows can return 402 insufficient_credits.

Persist Handoff State

Store the values a later agent, service, or workflow needs to resume without reading chat history.
{
  "agent_job_id": "mcp-research-q2",
  "surface": "api_mcp",
  "endpoint": "GET /api/v1/x/tweets/search",
  "query": "from:xquikcom MCP",
  "cursor_param": "cursor",
  "next_cursor": "DAACCgACGRElMJcAAA",
  "has_more": true,
  "webhook_id": "15",
  "delivery_id": "502",
  "stream_event_id": "9002",
  "event_replay_route": "GET /api/v1/events?after=9002",
  "export_route": "GET /api/v1/extractions/77777/export?format=json",
  "saved_fields": ["tweet_id", "author_username", "text", "url"]
}
Keep API keys, webhook secrets, raw request bodies, raw signatures, and full headers out of chat transcripts, shared agent memory, spreadsheets, CRM rows, and queue payloads.

When to Leave MCP

File Exports

Use extraction export endpoints for CSV, JSON, XLSX, Markdown, or PDF files.

Webhook Receivers

Use signed webhooks when downstream systems need fresh monitor events.

Replay Jobs

Use stored events and delivery rows when receivers miss work.

SDK Backends

Use SDKs when a backend owns retries, storage, and batch orchestration.

Next Steps

MCP Tools Reference

Review explore, xquik, sandbox inputs, response contracts, and examples.

Docs MCP Server

Connect read-only documentation search beside the API MCP server.

No-Code Handoff

Hand monitor events, exports, and direct reads to workflow platforms.

Webhook Testing

Verify signed receivers before accepting production events.
Last modified on May 24, 2026