G2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for G2 Credit Account API

3 actions 3 updates phrasing extends openapi/g2-credit-account-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/api/v2/organization/{organization_id}/credit_account'].get

$.paths['/api/v2/organization/{organization_id}/credit_deductions'].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 G2 Credit Account API
  version: 1.0.0
extends: openapi/g2-credit-account-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['/api/v2/organization/{organization_id}/credit_account'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an organization's API credit balance
      effect: read
      questions:
      - How many API credits does my organization have left?
      - Can I see total credits plus last month's deductions in one call?
      - What is the current metering balance on our G2 credit account?
      instructions:
      - text: Show the credit balance for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Get credit account {organization_id} including recent deductions.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/organization/{organization_id}/credit_deductions'].get
  update:
    x-apievangelist-phrasing:
      intent: Review monthly API credit usage
      effect: read
      questions:
      - How many credits did we spend each month?
      - Can I see credit deductions for a specific month and year?
      - What were our aggregated credit charges for last year?
      instructions:
      - text: List monthly credit deductions for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show credit deductions for {organization_id} in month {month} of {year}.
        slots:
          organization_id: path.organization_id
          month: query.filter[month]
          year: query.filter[year]
      method: generated
      generated: '2026-10-01'