Xquik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Xquik Draws API

5 actions 5 updates phrasing extends openapi/xquik-api-draws-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 5

$.info

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

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

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

$.paths['/api/v1/draws/{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 Draws API
  version: 1.0.0
extends: openapi/xquik-api-draws-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: 4
- target: $.paths['/api/v1/draws'].get
  update:
    x-apievangelist-phrasing:
      intent: List my giveaway draws
      effect: read
      questions:
      - Can I see all the giveaway draws I've run?
      - Is there a way to page through past giveaways?
      instructions:
      - text: List my giveaway draws.
      - text: Show my last {limit} draws.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/draws'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a giveaway draw on a tweet
      effect: write
      questions:
      - How do I pick random giveaway winners from replies to a tweet?
      - Can I require entrants to retweet and follow an account to win?
      - Can I pick backup winners in case a winner doesn't respond?
      - Does running a giveaway draw use up credits?
      instructions:
      - text: Run a giveaway draw on {tweetUrl} with {winnerCount} winners.
        slots:
          tweetUrl: requestBody.tweetUrl
          winnerCount: requestBody.winnerCount
      - text: Draw winners from {tweetUrl} who retweeted and follow @{mustFollowUsername}.
        slots:
          tweetUrl: requestBody.tweetUrl
          mustFollowUsername: requestBody.mustFollowUsername
      - text: Pick {winnerCount} winners and {backupCount} backups from {tweetUrl}, skipping accounts under {filterMinFollowers} followers.
        slots:
          winnerCount: requestBody.winnerCount
          backupCount: requestBody.backupCount
          tweetUrl: requestBody.tweetUrl
          filterMinFollowers: requestBody.filterMinFollowers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/draws/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a giveaway draw's details
      effect: read
      questions:
      - Who won a giveaway draw I ran?
      - Can I look up the details of one draw?
      instructions:
      - text: Get draw {id}.
        slots:
          id: path.id
      - text: Show the winners of giveaway draw {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/draws/{id}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a giveaway draw's data
      effect: read
      questions:
      - Can I export a draw's data as a file?
      - Which export formats can giveaway results be downloaded in?
      instructions:
      - text: Export draw {id} as {format}.
        slots:
          id: path.id
          format: query.format
      - text: Download the data from giveaway {id} in {format} format.
        slots:
          id: path.id
          format: query.format
      method: generated
      generated: '2026-09-26'