Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Metrics API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v2/metrics/budget:status'].post
$.paths['/v2/metrics/delete'].post
$.paths['/v2/metrics/download'].get
$.paths['/v2/metrics:bulk'].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 Deputy V2 Metrics API
  version: 1.0.0
extends: openapi/deputy-metrics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-17'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v2/metrics/budget:status'].post
  update:
    x-apievangelist-phrasing:
      intent: Check budget status for areas
      effect: read
      questions:
      - How do I check budget status for certain areas?
      - Can I check budget status for a date range?
      instructions:
      - text: Check budget status for areas {areas}.
        slots:
          areas: requestBody.areas
      - text: Check budget status for areas {areas} from {start} to {end}.
        slots:
          areas: requestBody.areas
          start: requestBody.start
          end: requestBody.end
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v2/metrics/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete metrics
      effect: destructive
      questions:
      - How do I delete metrics for certain areas?
      - Can I delete metrics for a date range?
      instructions:
      - text: Delete {type} metrics for areas {areas}.
        slots:
          type: requestBody.type
          areas: requestBody.areas
      - text: Delete {type} metrics for areas {areas} from {start} to {end}.
        slots:
          type: requestBody.type
          areas: requestBody.areas
          start: requestBody.start
          end: requestBody.end
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v2/metrics/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download metrics
      effect: read
      questions:
      - How do I download metrics for certain areas?
      - Can I download metrics for a date range?
      instructions:
      - text: Download metrics for areas {areas}.
        slots:
          areas: query.areas
      - text: Download {types} metrics for areas {areas} from {startYMD} to {endYMD}.
        slots:
          types: query.types
          areas: query.areas
          startYMD: query.startYMD
          endYMD: query.endYMD
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v2/metrics:bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Upsert metrics in bulk
      effect: write
      questions:
      - How do I upsert metrics in bulk?
      - Can I send a batch of metric records to create or update?
      instructions:
      - text: 'Upsert these metrics: {data}.'
        slots:
          data: requestBody.data
      - text: Create or update metrics in bulk with {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-metrics-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.