Xquik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Xquik Extractions API

6 actions 6 updates phrasing extends openapi/xquik-api-extractions-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Xquik's API. It is a proposal applied on top of the contract, not a document Xquik publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/v1/extractions'].get

$.paths['/api/v1/extractions'].post

$.paths['/api/v1/extractions/estimate'].post

$.paths['/api/v1/extractions/{id}'].get

$.paths['/api/v1/extractions/{id}/export'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Xquik Extractions API
  version: 1.0.0
extends: openapi/xquik-api-extractions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/api/v1/extractions'].get
  update:
    x-apievangelist-phrasing:
      intent: List my extraction jobs
      effect: read
      questions:
      - Which extraction jobs have I run?
      - Can I filter extraction jobs by status or tool type?
      instructions:
      - text: List my extraction jobs.
      - text: Show extraction jobs with status {status}.
        slots:
          status: query.status
      - text: Show only extraction jobs run with the {toolType} tool.
        slots:
          toolType: query.toolType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/extractions'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a bulk data extraction job
      effect: write
      questions:
      - Can I run a bulk extraction job on a tweet, user, community or list?
      - Is there a dry-run option before an extraction actually runs?
      - Can I dedupe results when extracting from several targets?
      instructions:
      - text: Run a {toolType} extraction on user {targetUsername}.
        slots:
          toolType: requestBody.toolType
          targetUsername: requestBody.targetUsername
      - text: Start a {toolType} extraction for tweet {targetTweetId}, capped at {resultsLimit} results.
        slots:
          toolType: requestBody.toolType
          targetTweetId: requestBody.targetTweetId
          resultsLimit: requestBody.resultsLimit
      - text: Run a {toolType} extraction across communities {targetCommunityIds}.
        slots:
          toolType: requestBody.toolType
          targetCommunityIds: requestBody.targetCommunityIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/extractions/estimate'].post
  update:
    x-apievangelist-phrasing:
      intent: Estimate an extraction's credit cost
      effect: read
      questions:
      - How much will an extraction job cost before I run it?
      - Can I get a credit estimate for extracting from several lists?
      instructions:
      - text: Estimate the cost of a {toolType} extraction on {targetUsername}.
        slots:
          toolType: requestBody.toolType
          targetUsername: requestBody.targetUsername
      - text: Quote the credits for a {toolType} extraction over lists {targetListIds}.
        slots:
          toolType: requestBody.toolType
          targetListIds: requestBody.targetListIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/extractions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read an extraction job's results
      effect: read
      questions:
      - Can I read the results of a finished extraction?
      - Can I page through extraction results and include the raw data?
      instructions:
      - text: Get results of extraction {id}.
        slots:
          id: path.id
      - text: Show the next page of extraction {id} results after cursor {cursor}.
        slots:
          id: path.id
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/extractions/{id}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export extraction results to a file
      effect: read
      questions:
      - Can I export extraction results to a file?
      - Can I filter exported rows by follower count or verified status?
      instructions:
      - text: Export extraction {id} as {format}.
        slots:
          id: path.id
          format: query.format
      - text: Export extraction {id} as {format}, keeping only rows with at least {minFollowers} followers.
        slots:
          id: path.id
          format: query.format
          minFollowers: query.minFollowers
      method: generated
      generated: '2026-09-26'