Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Storefront AI Usage API

3 actions 3 updates phrasing extends openapi/scope3-ai-usage-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/usage/by-model'].get

$.paths['/usage/summary'].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 Scope3 Storefront AI Usage API
  version: 1.0.0
extends: openapi/scope3-ai-usage-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: 2
- target: $.paths['/usage/by-model'].get
  update:
    x-apievangelist-phrasing:
      intent: Get daily AI token usage by model
      effect: read
      questions:
      - How has my storefront's AI token usage trended day by day?
      - Which model used the most tokens each day?
      instructions:
      - text: Show my storefront AI usage by model over time.
      - text: Show daily AI token usage per model since {since}.
        slots:
          since: query.since
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usage/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize AI token usage by model
      effect: read
      questions:
      - What is my total storefront AI token usage per model?
      - Are the estimated AI costs what I'll actually be charged?
      instructions:
      - text: Summarize my storefront AI usage.
      - text: Give me total AI token usage and estimated cost per model since {since}.
        slots:
          since: query.since
      method: generated
      generated: '2026-10-01'