RudderStack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for RudderStack HTTP Internal API

6 actions 6 updates phrasing extends openapi/rudderstack-internal-api-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for RudderStack's API. It is a proposal applied on top of the contract, not a document RudderStack publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/internal/v1/extract'].post
$.paths['/internal/v1/retl'].post
$.paths['/internal/v1/audiencelist'].post
$.paths['/internal/v1/replay'].post
$.paths['/internal/v1/batch'].post

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 RudderStack HTTP Internal API
  version: 1.0.0
extends: openapi/rudderstack-internal-api-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['/internal/v1/extract'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an internal extract request
      effect: write
      questions:
      - Where do extract requests go on the RudderStack internal API?
      - Which internal endpoint handles data extract jobs?
      instructions:
      - text: Submit this extract request to the internal extract endpoint.
      - text: Forward the extract payload to the internal extract handler.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal/v1/retl'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a reverse ETL request
      effect: write
      questions:
      - How do reverse ETL requests get sent into the internal API?
      - Which internal endpoint accepts reverse ETL syncs from a warehouse?
      instructions:
      - text: Send this reverse ETL request to the internal retl endpoint.
      - text: Push the reverse ETL payload through the internal handler.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal/v1/audiencelist'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an audience list request
      effect: write
      questions:
      - Where do I send an audience list request internally?
      - Is there an internal endpoint dedicated to audience lists?
      instructions:
      - text: Submit this audience list request to the internal audience list endpoint.
      - text: Forward the audience list payload to the internal handler.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal/v1/replay'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an event replay request
      effect: write
      questions:
      - Which internal endpoint handles replaying events?
      - Can I send replay requests through the internal API?
      instructions:
      - text: Send this replay request to the internal replay endpoint.
      - text: Submit the replay payload to the internal replay handler.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal/v1/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an internal batch request
      effect: write
      questions:
      - Where do internal batch requests go, separate from the public batch call?
      - Is there an internal-only batch endpoint?
      instructions:
      - text: Submit this batch to the internal batch endpoint, not the public v1 batch.
      - text: Forward the internal batch payload to the internal batch handler.
      method: generated
      generated: '2026-09-26'