Explorium · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Service Credits API

4 actions 4 updates phrasing extends openapi/explorium-credits-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 4

$.info

$.paths['/v1/credits/menu/{partner_id}'].get

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

$.paths['/v1/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 Credits API
  version: 1.0.0
extends: openapi/explorium-credits-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: 3
- target: $.paths['/v1/credits/menu/{partner_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the credits price menu for a partner
      effect: read
      questions:
      - How many credits does each enrichment cost for my partner account?
      - Where can I see the credit menu that applies to a partner?
      instructions:
      - text: Get the credits menu for partner {partner_id}.
        slots:
          partner_id: path.partner_id
      - text: Show credit prices per enrichment for partner {partner_id}.
        slots:
          partner_id: path.partner_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/credits'].get
  update:
    x-apievangelist-phrasing:
      intent: Show my active credits balance
      effect: read
      questions:
      - How many credits do I have left?
      - What's the summary of my currently active credit packages?
      instructions:
      - text: Show my active credits summary.
      - text: Tell me my remaining credit balance.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/credits/aggregation'].post
  update:
    x-apievangelist-phrasing:
      intent: Report credit usage over a date range
      effect: read
      questions:
      - How many credits did I spend between two dates?
      - Can I break down credit consumption by day or by 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 used from {from_date} to {to_date} at {resolution} resolution.
        slots:
          from_date: requestBody.from_date
          to_date: requestBody.to_date
          resolution: requestBody.resolution
      method: generated
      generated: '2026-10-01'