Svix · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Svix Event API

4 actions 4 updates phrasing extends openapi/svix-event-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Svix's API. It is a proposal applied on top of the contract, not a document Svix publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/api/v1/stream/{stream_id}/sink/{sink_id}/events'].get

$.paths['/api/v1/stream/{stream_id}/events'].post

$.paths['/api/v1/stream/{stream_id}/events/latest'].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 Svix Event API
  version: 1.0.0
extends: openapi/svix-event-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: 3
- target: $.paths['/api/v1/stream/{stream_id}/sink/{sink_id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Poll events from a poller sink
      effect: read
      questions:
      - How do I iterate over stream events through a poller-type sink?
      - Can I read a sink's events starting after a certain time?
      instructions:
      - text: Poll events from sink {sink_id} on stream {stream_id}.
        slots:
          sink_id: path.sink_id
          stream_id: path.stream_id
      - text: Read stream {stream_id} poller sink {sink_id} events after {after}.
        slots:
          stream_id: path.stream_id
          sink_id: path.sink_id
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/{stream_id}/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish events to a stream
      effect: write
      questions:
      - How do I push events into a Svix stream?
      - Can I send several events to a stream in one request?
      instructions:
      - text: Publish events {events} to stream {stream_id}.
        slots:
          events: requestBody.events
          stream_id: path.stream_id
      - text: Write this batch of events {events} onto stream {stream_id}.
        slots:
          events: requestBody.events
          stream_id: path.stream_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/{stream_id}/events/latest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stream's most recent events
      effect: read
      questions:
      - What are the latest events published to my stream?
      - Can I peek at the newest few events on a stream without a sink?
      instructions:
      - text: Get the latest events on stream {stream_id}.
        slots:
          stream_id: path.stream_id
      - text: Show the {limit} most recent events from stream {stream_id}.
        slots:
          limit: query.limit
          stream_id: path.stream_id
      method: generated
      generated: '2026-09-26'