Xquik · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Xquik Composition API
14 actions
14 updates
phrasing
extends
openapi/xquik-api-composition-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 14
$.info
$.paths['/api/v1/compose'].post
$.paths['/api/v1/drafts'].get
$.paths['/api/v1/drafts'].post
$.paths['/api/v1/drafts/{id}'].get
$.paths['/api/v1/drafts/{id}'].delete
$.paths['/api/v1/styles'].get
$.paths['/api/v1/styles'].post
$.paths['/api/v1/styles/compare'].get
$.paths['/api/v1/styles/{id}'].get
$.paths['/api/v1/styles/{id}'].put
$.paths['/api/v1/styles/{id}'].delete
$.paths['/api/v1/styles/{id}/performance'].get
$.paths['/api/v1/radar'].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 Composition API
version: 1.0.0
extends: openapi/xquik-api-composition-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: 13
- target: $.paths['/api/v1/compose'].post
update:
x-apievangelist-phrasing:
intent: Build, refine or score a post draft
effect: read
questions:
- Can Xquik help me build and refine a tweet draft step by step?
- Does the draft score predict how much reach my post will get?
- What editorial rules should my post follow before I publish it?
instructions:
- text: Run the compose step to get questions and rules for a new post.
- text: Score my post draft against the deterministic text checks.
- text: Refine my post draft toward its goal.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/drafts'].get
update:
x-apievangelist-phrasing:
intent: List my saved tweet drafts
effect: read
questions:
- Where can I see all my saved tweet drafts?
- Can I page through my drafts with a cursor?
instructions:
- text: List my saved drafts.
- text: Show my {limit} most recent saved drafts.
slots:
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/drafts'].post
update:
x-apievangelist-phrasing:
intent: Save a tweet draft
effect: write
questions:
- Can I save a tweet draft to finish later?
- Can I tag a saved draft with a topic and goal?
instructions:
- text: 'Save this tweet draft: {text}.'
slots:
text: requestBody.text
- text: Save draft {text} under topic {topic} with goal {goal}.
slots:
text: requestBody.text
topic: requestBody.topic
goal: requestBody.goal
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/drafts/{id}'].get
update:
x-apievangelist-phrasing:
intent: Open a saved draft
effect: read
questions:
- Can I open a single saved draft by its ID?
- What text did I store in a particular draft?
instructions:
- text: Get draft {id}.
slots:
id: path.id
- text: Show me the text of saved draft {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/drafts/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a saved draft
effect: destructive
questions:
- How do I delete a draft I no longer need?
- Can I remove a saved tweet draft permanently?
instructions:
- text: Delete draft {id}.
slots:
id: path.id
- text: Throw away saved draft {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/styles'].get
update:
x-apievangelist-phrasing:
intent: List my cached style profiles
effect: read
questions:
- Which writing style profiles have I already analyzed?
- Can I see all cached style profiles?
instructions:
- text: List my cached style profiles.
- text: Show every style profile I've saved.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/styles'].post
update:
x-apievangelist-phrasing:
intent: Analyze an account's writing style
effect: write
questions:
- Can I analyze someone's writing style from their recent tweets?
- How do I build a style profile for an X account?
instructions:
- text: Analyze the writing style of @{username}.
slots:
username: requestBody.username
- text: Build a style profile from {username}'s recent tweets.
slots:
username: requestBody.username
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/styles/compare'].get
update:
x-apievangelist-phrasing:
intent: Compare two writing style profiles
effect: read
questions:
- How does one account's tweeting style differ from another's?
- Can I compare two style profiles side by side?
instructions:
- text: Compare the writing styles of {username1} and {username2}.
slots:
username1: query.username1
username2: query.username2
- text: Put @{username1}'s style profile next to @{username2}'s.
slots:
username1: query.username1
username2: query.username2
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/styles/{id}'].get
update:
x-apievangelist-phrasing:
intent: View a cached style profile
effect: read
questions:
- Can I view a cached style profile by its ID?
- What did the saved style analysis say for a specific profile?
instructions:
- text: Get style profile {id}.
slots:
id: path.id
- text: Show me the cached style profile {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/styles/{id}'].put
update:
x-apievangelist-phrasing:
intent: Save a style profile from custom tweets
effect: write
questions:
- Can I build a style profile from my own hand-picked tweets?
- Is it possible to label a style profile and supply its sample tweets myself?
instructions:
- text: Save style profile {id} labeled {label} using tweets {tweets}.
slots:
id: path.id
label: requestBody.label
tweets: requestBody.tweets
- text: 'Overwrite style profile {id} with these sample tweets: {tweets}, labeled {label}.'
slots:
id: path.id
label: requestBody.label
tweets: requestBody.tweets
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/styles/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a style profile
effect: destructive
questions:
- What's the way to remove a style profile I no longer want?
- Can I delete a cached writing style analysis?
instructions:
- text: Delete style profile {id}.
slots:
id: path.id
- text: Remove the cached style analysis {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/styles/{id}/performance'].get
update:
x-apievangelist-phrasing:
intent: See engagement for a style's tweets
effect: read
questions:
- How well did the tweets in a style profile perform on engagement?
- Can I see engagement metrics for the tweets behind a style profile?
instructions:
- text: Show engagement metrics for style profile {id}.
slots:
id: path.id
- text: Get the engagement numbers for the tweets in style profile {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/radar'].get
update:
x-apievangelist-phrasing:
intent: See trending topics from curated sources
effect: read
questions:
- What topics are trending right now across curated news sources?
- Can I filter radar trends by category or region?
- Can I limit radar topics to the last few hours?
instructions:
- text: Show trending topics from the radar.
- text: Get radar topics in category {category} from the last {hours} hours.
slots:
category: query.category
hours: query.hours
- text: Show radar trends for region {region} from source {source}.
slots:
region: query.region
source: query.source
method: generated
generated: '2026-09-26'