Pirsch · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pirsch Authentication API

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

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/token'].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 Pirsch Authentication API
  version: 1.0.0
extends: openapi/pirsch-authentication-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Obtain an API access token
      effect: write
      questions:
      - How do I get a bearer token for the Pirsch API from my client credentials?
      - What do I need to exchange for an access token before calling the API?
      instructions:
      - text: Get an access token using client ID {client_id} and secret {client_secret}.
        slots:
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
      - text: Authenticate with OAuth client {client_id} and secret {client_secret} to get a bearer token.
        slots:
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
      method: generated
      generated: '2026-10-01'