Xquik · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Xquik Users API
16 actions
16 updates
phrasing
extends
openapi/xquik-api-users-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.
What the actions change
x-apievangelist-phrasing
Targets 16
$.info
$.paths['/api/v1/x/users/batch'].get
$.paths['/api/v1/x/users/search'].get
$.paths['/api/v1/x/users/{id}'].get
$.paths['/api/v1/x/followers/check'].get
$.paths['/api/v1/x/users/{id}/tweets'].get
$.paths['/api/v1/x/users/{id}/replies'].get
$.paths['/api/v1/x/users/{id}/likes'].get
$.paths['/api/v1/x/users/{id}/media'].get
$.paths['/api/v1/x/users/{id}/followers-you-know'].get
$.paths['/api/v1/x/notifications'].get
$.paths['/api/v1/x/dm/{userId}/history'].get
$.paths['/api/v1/x/users/{id}/followers'].get
$.paths['/api/v1/x/users/{id}/following'].get
$.paths['/api/v1/x/users/{id}/mentions'].get
$.paths['/api/v1/x/users/{id}/verified-followers'].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 Users API
version: 1.0.0
extends: openapi/xquik-api-users-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: 15
- target: $.paths['/api/v1/x/users/batch'].get
update:
x-apievangelist-phrasing:
intent: Look up several users by ID
effect: read
questions:
- Can I look up several X users by ID in one call?
- Is there a batch lookup for user IDs?
instructions:
- text: Look up users {ids}.
slots:
ids: query.ids
- text: 'Get profiles for these user IDs in one batch: {ids}.'
slots:
ids: query.ids
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/search'].get
update:
x-apievangelist-phrasing:
intent: Search users by name or handle
effect: read
questions:
- Can I find X accounts by name or handle?
- Can I search users and keep only those with a website in their profile?
instructions:
- text: Search users named {q}.
slots:
q: query.q
- text: Find accounts matching {q} with at least {minFollowers} followers.
slots:
q: query.q
minFollowers: query.minFollowers
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a user's profile
effect: read
questions:
- How many followers does a given X user have?
- Is a particular account verified?
instructions:
- text: Get the profile of user {id}.
slots:
id: path.id
- text: Show follower counts and verification for user {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/followers/check'].get
update:
x-apievangelist-phrasing:
intent: Check whether one user follows another
effect: read
questions:
- Does one X account follow another?
- Can I check whether a user follows me back?
instructions:
- text: Check if {source} follows {target}.
slots:
source: query.source
target: query.target
- text: Tell me whether {source} is following {target}.
slots:
source: query.source
target: query.target
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/tweets'].get
update:
x-apievangelist-phrasing:
intent: List a user's recent tweets
effect: read
questions:
- What has an account tweeted recently?
- Can I include replies when listing a user's recent posts?
instructions:
- text: List recent tweets by user {id}.
slots:
id: path.id
- text: Get tweets from user {id} since {sinceDate} with at least {minFaves} likes.
slots:
id: path.id
sinceDate: query.sinceDate
minFaves: query.minFaves
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/replies'].get
update:
x-apievangelist-phrasing:
intent: Read a user's With Replies timeline
effect: read
questions:
- Can I see a user's With Replies timeline?
- Where can I get both the posts and the replies authored by one account?
instructions:
- text: Get the With Replies timeline for user {id}.
slots:
id: path.id
- text: List replies and posts by user {id} in {language}.
slots:
id: path.id
language: query.language
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/likes'].get
update:
x-apievangelist-phrasing:
intent: List tweets a user liked
effect: read
questions:
- Which tweets has a user liked?
- Can I see the posts an account has favorited?
instructions:
- text: List tweets liked by user {id}.
slots:
id: path.id
- text: Show tweets user {id} liked that contain {hashtags}.
slots:
id: path.id
hashtags: query.hashtags
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/media'].get
update:
x-apievangelist-phrasing:
intent: List a user's media tweets
effect: read
questions:
- Can I list only the photo and video tweets from an account?
- Where can I find all media posts by a user?
instructions:
- text: List media tweets from user {id}.
slots:
id: path.id
- text: Show {mediaType} posts by user {id}.
slots:
id: path.id
mediaType: query.mediaType
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/followers-you-know'].get
update:
x-apievangelist-phrasing:
intent: List mutual followers with a user
effect: read
questions:
- Which of my followers also follow a particular user?
- Can I see mutual connections with another account?
instructions:
- text: List followers I have in common with user {id}.
slots:
id: path.id
- text: Show mutual followers between me and {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/notifications'].get
update:
x-apievangelist-phrasing:
intent: Read my X notifications
effect: read
questions:
- Can I read my X notifications?
- Can I filter notifications by type?
instructions:
- text: Show my notifications.
- text: Get my {type} notifications.
slots:
type: query.type
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/dm/{userId}/history'].get
update:
x-apievangelist-phrasing:
intent: Read a DM conversation
effect: read
questions:
- Can I read my DM conversation with someone?
- Can I page back through older direct messages?
instructions:
- text: Get DM history with user {userId} for account {account}.
slots:
userId: path.userId
account: query.account
- text: Show direct messages between {account} and {userId}.
slots:
userId: path.userId
account: query.account
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/followers'].get
update:
x-apievangelist-phrasing:
intent: List a user's followers
effect: read
questions:
- Who follows a given X account?
- Can I filter an account's followers by a bio keyword?
instructions:
- text: List followers of user {id}.
slots:
id: path.id
- text: Find followers of {id} whose bio contains {bioContains}.
slots:
id: path.id
bioContains: query.bioContains
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/following'].get
update:
x-apievangelist-phrasing:
intent: List accounts a user follows
effect: read
questions:
- Which accounts does a user follow?
- Can I see who an account is following, filtered to verified users?
instructions:
- text: List accounts user {id} follows.
slots:
id: path.id
- text: Show accounts followed by {id} with over {minFollowers} followers.
slots:
id: path.id
minFollowers: query.minFollowers
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/mentions'].get
update:
x-apievangelist-phrasing:
intent: List tweets mentioning a user
effect: read
questions:
- Which tweets mention a particular user?
- Can I find mentions of an account within a time window?
instructions:
- text: List tweets mentioning user {id}.
slots:
id: path.id
- text: Show mentions of {id} between {sinceTime} and {untilTime}.
slots:
id: path.id
sinceTime: query.sinceTime
untilTime: query.untilTime
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/x/users/{id}/verified-followers'].get
update:
x-apievangelist-phrasing:
intent: List a user's verified followers
effect: read
questions:
- Which verified accounts follow a given user?
- Can I list just the blue-check followers of an account?
instructions:
- text: List verified followers of user {id}.
slots:
id: path.id
- text: Show verified followers of {id} whose username contains {usernameContains}.
slots:
id: path.id
usernameContains: query.usernameContains
method: generated
generated: '2026-09-26'