Explorium · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Service V2Credits API

3 actions 3 updates phrasing extends openapi/explorium-v2credits-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v2/credits'].get

$.paths['/v2/credits/aggregation'].post

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 Partner Service V2Credits API
  version: 1.0.0
extends: openapi/explorium-v2credits-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['/v2/credits'].get
  update:
    x-apievangelist-phrasing:
      intent: Show my active credits balance (v2)
      effect: read
      questions:
      - How many credits remain on my account?
      - What active credit packages do I have right now?
      instructions:
      - text: Show my active credits summary.
      - text: Tell me my remaining credits.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/credits/aggregation'].post
  update:
    x-apievangelist-phrasing:
      intent: Report credit usage over a date range (v2)
      effect: read
      questions:
      - How many credits did I use over a given period?
      - Can I break down credit spend by time resolution or API key?
      instructions:
      - text: Report credit usage from {from_date} to {to_date} in {mode} mode.
        slots:
          from_date: requestBody.from_date
          to_date: requestBody.to_date
          mode: requestBody.mode
      - text: Aggregate credits for key {key_name} from {from_date} to {to_date}.
        slots:
          key_name: requestBody.key_name
          from_date: requestBody.from_date
          to_date: requestBody.to_date
      method: generated
      generated: '2026-10-01'