X · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X API v2 Spaces API

7 actions 7 updates phrasing extends openapi/x-spaces-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 7

$.info
$.paths['/2/spaces'].get
$.paths['/2/spaces/by/creator_ids'].get
$.paths['/2/spaces/search'].get
$.paths['/2/spaces/{id}'].get
$.paths['/2/spaces/{id}/buyers'].get
$.paths['/2/spaces/{id}/tweets'].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 Spaces API
  version: 1.0.0
extends: openapi/x-spaces-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: 6
- target: $.paths['/2/spaces'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up several Spaces by ID
      effect: read
      questions:
      - Can I fetch details for multiple Spaces in one request?
      - What state and host info comes back for a batch of Space IDs?
      instructions:
      - text: Get the Spaces with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Look up these Spaces at once: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/spaces/by/creator_ids'].get
  update:
    x-apievangelist-phrasing:
      intent: Find Spaces hosted by given users
      effect: read
      questions:
      - Which Spaces are certain users hosting?
      - How do I find Spaces created by a list of accounts?
      instructions:
      - text: Find Spaces created by users {user_ids}.
        slots:
          user_ids: query.user_ids
      - text: Show Spaces hosted by {user_ids}.
        slots:
          user_ids: query.user_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/spaces/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Spaces by keyword
      effect: read
      questions:
      - Are there any live Spaces about a topic right now?
      - Can I search only scheduled Spaces matching a keyword?
      instructions:
      - text: Search Spaces for {query}.
        slots:
          query: query.query
      - text: Find {state} Spaces about {query}.
        slots:
          state: query.state
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/spaces/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Space by ID
      effect: read
      questions:
      - What details does a single Space expose?
      - Is a particular Space live, scheduled or ended?
      instructions:
      - text: Get Space {id}.
        slots:
          id: path.id
      - text: Show the title and state of Space {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/spaces/{id}/buyers'].get
  update:
    x-apievangelist-phrasing:
      intent: List ticket buyers for a Space
      effect: read
      questions:
      - Who bought tickets to my ticketed Space?
      - Can I page through a Space's ticket purchasers?
      instructions:
      - text: List the ticket buyers for Space {id}.
        slots:
          id: path.id
      - text: Show {max_results} users who purchased tickets to Space {id}.
        slots:
          max_results: query.max_results
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/spaces/{id}/tweets'].get
  update:
    x-apievangelist-phrasing:
      intent: Get posts shared in a Space
      effect: read
      questions:
      - Which posts were shared during a Space?
      - Can I retrieve the posts pinned or shared in a specific Space?
      instructions:
      - text: Show the posts shared in Space {id}.
        slots:
          id: path.id
      - text: Get {max_results} posts from Space {id}.
        slots:
          max_results: query.max_results
          id: path.id
      method: generated
      generated: '2026-09-26'