Xquik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Xquik Articles API

2 actions 2 updates phrasing extends openapi/xquik-api-articles-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 2

$.info

$.paths['/api/v1/x/articles/{tweetId}'].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 Articles API
  version: 1.0.0
extends: openapi/xquik-api-articles-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: 1
- target: $.paths['/api/v1/x/articles/{tweetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the full content of an X Article
      effect: read
      questions:
      - Can I get the full text of an X Article from its tweet ID?
      - Does the article lookup return the cover image of a long-form X post?
      - What happens if the tweet I pass is not an X Article?
      instructions:
      - text: Get the full X Article for tweet {tweetId}.
        slots:
          tweetId: path.tweetId
      - text: Pull the long-form article text and cover image from post {tweetId}.
        slots:
          tweetId: path.tweetId
      method: generated
      generated: '2026-09-26'