Stax · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stax-api Ephemeral API

2 actions 2 updates phrasing extends openapi/stax-ephemeral-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/ephemeral'].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 stax-api Ephemeral API
  version: 1.0.0
extends: openapi/stax-ephemeral-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: 1
- target: $.paths['/ephemeral'].get
  update:
    x-apievangelist-phrasing:
      intent: Issue a short-lived authentication token
      effect: read
      questions:
      - Can I exchange my Stax API key for a temporary token that expires in 24 hours?
      - Is it possible to get an ephemeral token scoped to a specific user?
      instructions:
      - text: Generate an ephemeral auth token from my API key.
      - text: Issue a 24-hour ephemeral token for the user with email {user_email}.
        slots:
          user_email: query.user_email
      - text: Get an ephemeral token for user {user_id}.
        slots:
          user_id: query.user_id
      method: generated
      generated: '2026-09-26'