X · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X API v2 Articles API

3 actions 3 updates phrasing extends openapi/x-articles-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for X's API. It is a proposal applied on top of the contract, not a document X publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/2/articles/draft'].post

$.paths['/2/articles/{article_id}/publish'].post

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 X API v2 Articles API
  version: 1.0.0
extends: openapi/x-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: 2
- target: $.paths['/2/articles/draft'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a draft Article
      effect: write
      questions:
      - Can I start a long-form Article on X as a draft first?
      - Can I add a cover image when drafting an Article?
      instructions:
      - text: Create a draft Article titled {title} with content {content_state}.
        slots:
          title: requestBody.title
          content_state: requestBody.content_state
      - text: Draft an Article called {title} using cover media {cover_media} and body {content_state}.
        slots:
          title: requestBody.title
          cover_media: requestBody.cover_media
          content_state: requestBody.content_state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/articles/{article_id}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a draft Article
      effect: write
      questions:
      - How do I make a drafted Article publicly visible?
      - What call publishes an Article I saved as a draft?
      instructions:
      - text: Publish Article draft {article_id}.
        slots:
          article_id: path.article_id
      - text: Make Article {article_id} public now.
        slots:
          article_id: path.article_id
      method: generated
      generated: '2026-09-26'