# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Xquik Tweets API
  version: 1.0.0
extends: openapi/xquik-api-tweets-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: 11
- target: $.paths['/api/v1/x/tweets'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up several tweets by ID
      effect: read
      questions:
      - Can I fetch several tweets at once by their IDs?
      - Is there a bulk lookup for a list of tweet IDs?
      instructions:
      - text: Get tweets {ids}.
        slots:
          ids: query.ids
      - text: 'Look up these tweet IDs in one batch: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search tweets
      effect: read
      questions:
      - How do I search tweets for a keyword?
      - Can I search tweets from one account within a date range?
      - Can I find only well-liked tweets about a topic?
      instructions:
      - text: Search tweets for {q}.
        slots:
          q: query.q
      - text: Search tweets from @{fromUser} about {q} since {sinceDate}.
        slots:
          fromUser: query.fromUser
          q: query.q
          sinceDate: query.sinceDate
      - text: Find tweets matching {q} in language {language} with at least {minFaves} likes.
        slots:
          q: query.q
          language: query.language
          minFaves: query.minFaves
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single tweet
      effect: read
      questions:
      - Can I get a single tweet's full text, author and metrics?
      - What media is attached to a specific tweet?
      instructions:
      - text: Get tweet {id}.
        slots:
          id: path.id
      - text: Show the full text, author and engagement stats for tweet {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/{id}/favoriters'].get
  update:
    x-apievangelist-phrasing:
      intent: List users who liked a tweet
      effect: read
      questions:
      - Who liked a specific tweet?
      - Why might the likers of a post come back as unavailable?
      - Can I filter a tweet's likers to verified users?
      instructions:
      - text: List users who liked tweet {id}.
        slots:
          id: path.id
      - text: Show likers of tweet {id} with over {minFollowers} followers.
        slots:
          id: path.id
          minFollowers: query.minFollowers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/bookmarks'].get
  update:
    x-apievangelist-phrasing:
      intent: Read my bookmarked tweets
      effect: read
      questions:
      - Can I read my bookmarked tweets?
      - Can I get bookmarks from one specific folder?
      instructions:
      - text: Show my bookmarked tweets.
      - text: Get bookmarks in folder {folderId}.
        slots:
          folderId: query.folderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/bookmarks/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List my bookmark folders
      effect: read
      questions:
      - What bookmark folders do I have?
      - Can I list my bookmark folder names and IDs?
      instructions:
      - text: List my bookmark folders.
      - text: Show all folders I organize bookmarks into.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/timeline'].get
  update:
    x-apievangelist-phrasing:
      intent: Read my home timeline
      effect: read
      questions:
      - Can I read my home timeline through the API?
      - Can I skip tweets I've already seen on my timeline?
      instructions:
      - text: Show my home timeline.
      - text: Get my home timeline, excluding tweets {seenTweetIds}.
        slots:
          seenTweetIds: query.seenTweetIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/{id}/quotes'].get
  update:
    x-apievangelist-phrasing:
      intent: List quote tweets of a post
      effect: read
      questions:
      - Who has quote-tweeted a post?
      - Can I see quote tweets of a post within a date window?
      instructions:
      - text: List quote tweets of tweet {id}.
        slots:
          id: path.id
      - text: Show quotes of tweet {id} posted since {sinceDate}.
        slots:
          id: path.id
          sinceDate: query.sinceDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/{id}/replies'].get
  update:
    x-apievangelist-phrasing:
      intent: List replies to a tweet
      effect: read
      questions:
      - Can I get every reply to a tweet, including nested replies?
      - What does complete mode do when fetching replies?
      - Can I exclude the original author's own replies?
      instructions:
      - text: List replies to tweet {id}.
        slots:
          id: path.id
      - text: Get replies to tweet {id} in {mode} mode, sorted by {sort}.
        slots:
          id: path.id
          mode: query.mode
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/{id}/retweeters'].get
  update:
    x-apievangelist-phrasing:
      intent: List users who retweeted a tweet
      effect: read
      questions:
      - Who retweeted a particular post?
      - Can I filter retweeters by minimum follower count?
      instructions:
      - text: List users who retweeted tweet {id}.
        slots:
          id: path.id
      - text: Show retweeters of {id} with accounts older than {minAccountAgeDays} days.
        slots:
          id: path.id
          minAccountAgeDays: query.minAccountAgeDays
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/{id}/thread'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the conversation thread of a tweet
      effect: read
      questions:
      - Can I get the whole conversation thread around a tweet?
      - Can I narrow a thread to messages from one user?
      instructions:
      - text: Get the full thread for tweet {id}.
        slots:
          id: path.id
      - text: Show thread {id} but only posts from @{fromUser}.
        slots:
          id: path.id
          fromUser: query.fromUser
      method: generated
      generated: '2026-09-26'