Xquik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Xquik X Accounts API

9 actions 9 updates phrasing extends openapi/xquik-api-x-accounts-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 9

$.info
$.paths['/api/v1/x/accounts'].get
$.paths['/api/v1/x/accounts'].post
$.paths['/api/v1/x/account-connection-attempts/{id}'].get
$.paths['/api/v1/x/account-connection-challenges/{id}/submit'].post
$.paths['/api/v1/x/accounts/{id}'].get
$.paths['/api/v1/x/accounts/{id}'].delete
$.paths['/api/v1/x/accounts/{id}/reauth'].post
$.paths['/api/v1/x/accounts/bulk-retry'].post

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 Accounts API
  version: 1.0.0
extends: openapi/xquik-api-x-accounts-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: 8
- target: $.paths['/api/v1/x/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List my connected X accounts
      effect: read
      questions:
      - Which X accounts have I connected?
      - Can I see the status of every connected X account?
      instructions:
      - text: List my connected X accounts.
      - text: Show all X accounts connected to my Xquik account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect an X account
      effect: write
      questions:
      - How do I connect my X account so the API can post for me?
      - What credentials are needed to connect an X account?
      instructions:
      - text: Connect X account {username} with email {email}, password {password} and 2FA secret {totp_secret}.
        slots:
          username: requestBody.username
          email: requestBody.email
          password: requestBody.password
          totp_secret: requestBody.totp_secret
      - text: Link X account {username} using email {email}, password {password}, TOTP secret {totp_secret}.
        slots:
          username: requestBody.username
          email: requestBody.email
          password: requestBody.password
          totp_secret: requestBody.totp_secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/account-connection-attempts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an X account connection attempt
      effect: read
      questions:
      - Did my X account connection attempt succeed?
      - Is my X account connection still pending?
      instructions:
      - text: Check connection attempt {id}.
        slots:
          id: path.id
      - text: Get the status of X account connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/account-connection-challenges/{id}/submit'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an X email verification code
      effect: write
      questions:
      - X asked for an email verification code while connecting; how do I submit it?
      - Where do I enter the email code to finish connecting my X account?
      instructions:
      - text: Submit code {email_code} for connection challenge {id}.
        slots:
          id: path.id
          email_code: requestBody.email_code
      - text: Enter email verification code {email_code} on challenge {id}.
        slots:
          id: path.id
          email_code: requestBody.email_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connected X account
      effect: read
      questions:
      - Can I see the details of one connected X account?
      - What is stored about a specific connected X account?
      instructions:
      - text: Get connected X account {id}.
        slots:
          id: path.id
      - text: Show details for X account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/accounts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disconnect an X account
      effect: destructive
      questions:
      - What's the way to disconnect an X account?
      - Can I unlink a connected X account so it can no longer be used?
      instructions:
      - text: Disconnect X account {id}.
        slots:
          id: path.id
      - text: Unlink connected X account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/accounts/{id}/reauth'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-authenticate a connected X account
      effect: write
      questions:
      - What do I do when a connected X account needs to log in again?
      - Can I update a connected account's password after I changed it on X?
      instructions:
      - text: Re-authenticate X account {id} with password {password}.
        slots:
          id: path.id
          password: requestBody.password
      - text: Re-login X account {id} using password {password} and TOTP secret {totp_secret}.
        slots:
          id: path.id
          password: requestBody.password
          totp_secret: requestBody.totp_secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/accounts/bulk-retry'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry all temporarily failed X accounts
      effect: write
      questions:
      - Can I retry all X accounts that failed to log in temporarily?
      - Is there a way to clear transient login failures across my accounts?
      instructions:
      - text: Retry all temporarily failed X accounts.
      - text: Clear transient login failures on my X accounts.
      method: generated
      generated: '2026-09-26'