Xquik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Xquik X Write API

20 actions 20 updates phrasing extends openapi/xquik-api-x-write-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 20 · first 16 shown; the file carries all of them

$.info
$.paths['/api/v1/x/tweets'].post
$.paths['/api/v1/x/write-actions/{id}'].get
$.paths['/api/v1/x/tweets/{id}'].delete
$.paths['/api/v1/x/tweets/{id}/like'].post
$.paths['/api/v1/x/tweets/{id}/like'].delete
$.paths['/api/v1/x/tweets/{id}/retweet'].post
$.paths['/api/v1/x/tweets/{id}/retweet'].delete
$.paths['/api/v1/x/users/{id}/follow'].post
$.paths['/api/v1/x/users/{id}/follow'].delete
$.paths['/api/v1/x/users/{id}/remove-follower'].post
$.paths['/api/v1/x/dm/{userId}'].post
$.paths['/api/v1/x/media'].post
$.paths['/api/v1/x/profile'].patch
$.paths['/api/v1/x/profile/avatar'].patch
$.paths['/api/v1/x/profile/banner'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Xquik X Write API
  version: 1.0.0
extends: openapi/xquik-api-x-write-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: 19
- target: $.paths['/api/v1/x/tweets'].post
  update:
    x-apievangelist-phrasing:
      intent: Post a tweet
      effect: write
      questions:
      - How do I post a tweet through the API?
      - Can I post a reply or post into a community?
      - Can I publish a long note tweet with media?
      instructions:
      - text: Post {text} from account {account}.
        slots:
          text: requestBody.text
          account: requestBody.account
      - text: Reply to tweet {reply_to_tweet_id} with {text} from {account}.
        slots:
          reply_to_tweet_id: requestBody.reply_to_tweet_id
          text: requestBody.text
          account: requestBody.account
      - text: Post {text} to community {community_id} as {account}.
        slots:
          text: requestBody.text
          community_id: requestBody.community_id
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/write-actions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a write action's status
      effect: read
      questions:
      - Did my queued tweet or like actually go through?
      - Can I check the status of a write action?
      instructions:
      - text: Get write action {id}.
        slots:
          id: path.id
      - text: Check whether write action {id} finished.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tweet
      effect: destructive
      questions:
      - Can I delete a tweet I posted?
      - How do I remove a post from my connected account?
      instructions:
      - text: Delete tweet {id} from account {account}.
        slots:
          id: path.id
          account: requestBody.account
      - text: Remove post {id} posted by {account}.
        slots:
          id: path.id
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/{id}/like'].post
  update:
    x-apievangelist-phrasing:
      intent: Like a tweet
      effect: write
      questions:
      - Can I like a tweet from a connected account?
      - Is there a way to automate liking posts?
      instructions:
      - text: Like tweet {id} as {account}.
        slots:
          id: path.id
          account: requestBody.account
      - text: Have {account} like post {id}.
        slots:
          id: path.id
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/{id}/like'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a like from a tweet
      effect: destructive
      questions:
      - How do I remove a like from a tweet?
      - Can I undo a like my account made?
      instructions:
      - text: Unlike tweet {id} as {account}.
        slots:
          id: path.id
          account: requestBody.account
      - text: Remove {account}'s like from post {id}.
        slots:
          id: path.id
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/{id}/retweet'].post
  update:
    x-apievangelist-phrasing:
      intent: Retweet a post
      effect: write
      questions:
      - Can I retweet a post from my connected account?
      - Is it possible to repost a tweet via the API?
      instructions:
      - text: Retweet {id} from {account}.
        slots:
          id: path.id
          account: requestBody.account
      - text: Have {account} repost tweet {id}.
        slots:
          id: path.id
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/tweets/{id}/retweet'].delete
  update:
    x-apievangelist-phrasing:
      intent: Undo a retweet
      effect: destructive
      questions:
      - How do I undo a retweet?
      - Can I remove a repost my account made?
      instructions:
      - text: Undo the retweet of {id} on {account}.
        slots:
          id: path.id
          account: requestBody.account
      - text: Unretweet tweet {id} as {account}.
        slots:
          id: path.id
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/follow'].post
  update:
    x-apievangelist-phrasing:
      intent: Follow a user
      effect: write
      questions:
      - Can I follow an X user from a connected account?
      - Is there a way to automate following accounts?
      instructions:
      - text: Follow user {id} from {account}.
        slots:
          id: path.id
          account: requestBody.account
      - text: Have {account} follow user {id}.
        slots:
          id: path.id
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/follow'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unfollow a user
      effect: destructive
      questions:
      - How do I unfollow someone from my connected account?
      - Can I stop following a user via the API?
      instructions:
      - text: Unfollow user {id} on {account}.
        slots:
          id: path.id
          account: requestBody.account
      - text: Make {account} stop following {id}.
        slots:
          id: path.id
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/remove-follower'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a follower
      effect: destructive
      questions:
      - Can I remove a specific follower from my account?
      - Is there a way to make a user stop following me?
      instructions:
      - text: Remove follower {id} from {account}.
        slots:
          id: path.id
          account: requestBody.account
      - text: Drop user {id} from {account}'s followers.
        slots:
          id: path.id
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/dm/{userId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a direct message
      effect: write
      questions:
      - Can I send a direct message from my connected account?
      - Can I attach media to a DM?
      instructions:
      - text: 'DM user {userId} from {account}: {text}.'
        slots:
          userId: path.userId
          account: requestBody.account
          text: requestBody.text
      - text: Send {text} with media {media_ids} to {userId} as {account}.
        slots:
          userId: path.userId
          account: requestBody.account
          text: requestBody.text
          media_ids: requestBody.media_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/media'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an image or video
      effect: write
      questions:
      - How do I upload an image or video to attach to a tweet?
      - Can I upload a long video for a post?
      instructions:
      - text: Upload media from {url} for {account}.
        slots:
          url: requestBody.url
          account: requestBody.account
      - text: Upload {file} for account {account}.
        slots:
          file: requestBody.file
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/profile'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update my X profile details
      effect: write
      questions:
      - Can I change my X display name and bio?
      - Can I update the location and website on my profile?
      instructions:
      - text: Change {account}'s display name to {name}.
        slots:
          account: requestBody.account
          name: requestBody.name
      - text: Set the bio of {account} to {description}.
        slots:
          account: requestBody.account
          description: requestBody.description
      - text: Update {account}'s location to {location} and website to {url}.
        slots:
          account: requestBody.account
          location: requestBody.location
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/profile/avatar'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change my profile picture
      effect: write
      questions:
      - How do I change my X profile picture?
      - Can I set a new avatar from an image URL?
      instructions:
      - text: Set {account}'s avatar to {url}.
        slots:
          account: requestBody.account
          url: requestBody.url
      - text: Upload {file} as the profile picture for {account}.
        slots:
          account: requestBody.account
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/profile/banner'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change my profile banner
      effect: write
      questions:
      - Can I change the header banner on my X profile?
      - Can I set a profile banner from an image URL?
      instructions:
      - text: Set {account}'s banner to {url}.
        slots:
          account: requestBody.account
          url: requestBody.url
      - text: Upload {file} as the header banner for {account}.
        slots:
          account: requestBody.account
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/communities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an X Community
      effect: write
      questions:
      - Can I create a new X Community?
      - Can I give a new community a description?
      instructions:
      - text: Create a community named {name} from {account}.
        slots:
          name: requestBody.name
          account: requestBody.account
      - text: Start community {name} described as {description} as {account}.
        slots:
          name: requestBody.name
          description: requestBody.description
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/communities/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an X Community
      effect: destructive
      questions:
      - How do I delete an X Community I own?
      - Why do I need to confirm the community name to delete it?
      instructions:
      - text: Delete community {id} named {community_name} as {account}.
        slots:
          id: path.id
          community_name: requestBody.community_name
          account: requestBody.account
      - text: Permanently remove community {id} ({community_name}) owned by {account}.
        slots:
          id: path.id
          community_name: requestBody.community_name
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/communities/{id}/join'].post
  update:
    x-apievangelist-phrasing:
      intent: Join an X Community
      effect: write
      questions:
      - Can I join an X Community from my connected account?
      - Is joining a community something I can automate?
      instructions:
      - text: Join community {id} as {account}.
        slots:
          id: path.id
          account: requestBody.account
      - text: Have {account} join community {id}.
        slots:
          id: path.id
          account: requestBody.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/communities/{id}/join'].delete
  update:
    x-apievangelist-phrasing:
      intent: Leave an X Community
      effect: destructive
      questions:
      - How do I leave an X Community?
      - Can I exit a community my account joined?
      instructions:
      - text: Leave community {id} as {account}.
        slots:
          id: path.id
          account: requestBody.account
      - text: Take {account} out of community {id}.
        slots:
          id: path.id
          account: requestBody.account
      method: generated
      generated: '2026-09-26'