X · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X API v2 News API

3 actions 3 updates phrasing extends openapi/x-news-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/news/search'].get
$.paths['/2/news/{id}'].get

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 X API v2 News API
  version: 1.0.0
extends: openapi/x-news-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/news/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search news stories
      effect: read
      questions:
      - What news stories on X are about a given topic?
      - Can I limit news search to stories from the last few hours?
      instructions:
      - text: Search news for {query}.
        slots:
          query: query.query
      - text: Find news about {query} from the last {max_age_hours} hours.
        slots:
          query: query.query
          max_age_hours: query.max_age_hours
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/news/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a news story by ID
      effect: read
      questions:
      - How do I fetch one news story when I already have its ID?
      - Which fields can I request for a single news story?
      instructions:
      - text: Get news story {id}.
        slots:
          id: path.id
      - text: Show news story {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.news.fields
      method: generated
      generated: '2026-09-26'