X · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X API v2 Usage API

3 actions 3 updates phrasing extends openapi/x-usage-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/usage/credits'].get

$.paths['/2/usage/tweets'].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 X API v2 Usage API
  version: 1.0.0
extends: openapi/x-usage-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/usage/credits'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my developer credit balance
      effect: read
      questions:
      - How much developer-platform credit do I have left in USD?
      - Can my prepaid credit balance go negative?
      instructions:
      - text: Show my developer credit balance.
      - text: Check how many dollars of API credit remain on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/usage/tweets'].get
  update:
    x-apievangelist-phrasing:
      intent: Get post consumption usage
      effect: read
      questions:
      - How many posts has my app consumed recently?
      - Can I see daily post usage over a chosen number of days?
      instructions:
      - text: Show my post consumption usage.
      - text: Get my post usage for the last {days} days.
        slots:
          days: query.days
      method: generated
      generated: '2026-09-26'