Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Replays Recording Segments API

3 actions 3 updates phrasing extends openapi/sentry-system-recording-segments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Sentry's API. It is a proposal applied on top of the contract, not a document Sentry publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/recording-segments/'].get
$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/recording-segments/{segment_id}/'].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 Sentry Replays Recording Segments API
  version: 1.0.0
extends: openapi/sentry-system-recording-segments-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['/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/recording-segments/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a replay's recording segments
      effect: read
      questions:
      - How do I download the raw recording data of a replay?
      - Can I page through every segment of a session replay?
      instructions:
      - text: List recording segments for replay {replay_id} in project {project} of {org}.
        slots:
          replay_id: path.replay_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Show the next segments of replay {replay_id} from cursor {cursor}.
        slots:
          replay_id: path.replay_id
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/recording-segments/{segment_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one recording segment
      effect: read
      questions:
      - Can I fetch a single segment of a replay recording?
      - What does one chunk of a session recording contain?
      instructions:
      - text: Get segment {segment_id} of replay {replay_id} in project {project} of {org}.
        slots:
          segment_id: path.segment_id
          replay_id: path.replay_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Fetch recording segment {segment_id} for replay {replay_id}.
        slots:
          segment_id: path.segment_id
          replay_id: path.replay_id
      method: generated
      generated: '2026-09-26'