X · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X API v2 Activity API

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

$.info
$.paths['/2/activity/subscriptions'].get
$.paths['/2/activity/subscriptions'].post
$.paths['/2/activity/subscriptions'].delete
$.paths['/2/activity/subscriptions/{subscription_id}'].put
$.paths['/2/activity/subscriptions/{subscription_id}'].delete

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 Activity API
  version: 1.0.0
extends: openapi/x-activity-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: 5
- target: $.paths['/2/activity/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List X activity subscriptions
      effect: read
      questions:
      - Which X activity event subscriptions are active for my app?
      - Can I page through all my activity subscriptions?
      instructions:
      - text: List my active X activity subscriptions.
      - text: Show up to {max_results} of my activity event subscriptions.
        slots:
          max_results: query.max_results
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/activity/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to an X activity event
      effect: write
      questions:
      - How do I subscribe to like or follow events for a user and send them to my webhook?
      - What OAuth scope does my token need to subscribe to chat or DM activity events?
      instructions:
      - text: Subscribe to {event_type} events matching filter {filter}.
        slots:
          event_type: requestBody.event_type
          filter: requestBody.filter
      - text: Create a {event_type} activity subscription with filter {filter} delivered to webhook {webhook_id}.
        slots:
          event_type: requestBody.event_type
          filter: requestBody.filter
          webhook_id: requestBody.webhook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/activity/subscriptions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several activity subscriptions at once
      effect: destructive
      questions:
      - Can I remove multiple X activity subscriptions in one call?
      - Is there a bulk delete for activity subscriptions by ID?
      instructions:
      - text: Delete the activity subscriptions {ids}.
        slots:
          ids: query.ids
      - text: 'Bulk remove these activity subscription IDs: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/activity/subscriptions/{subscription_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an activity subscription's webhook or tag
      effect: write
      questions:
      - How do I point an existing activity subscription at a different webhook?
      - Can I change the tag on an activity subscription I already created?
      instructions:
      - text: Move activity subscription {subscription_id} to webhook {webhook_id}.
        slots:
          subscription_id: path.subscription_id
          webhook_id: requestBody.webhook_id
      - text: Retag activity subscription {subscription_id} as {tag}.
        slots:
          subscription_id: path.subscription_id
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/activity/subscriptions/{subscription_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one activity subscription
      effect: destructive
      questions:
      - How do I cancel a single X activity subscription?
      - What happens when I delete one activity event subscription by its ID?
      instructions:
      - text: Delete activity subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Stop the single activity subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-09-26'