Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Area Rate API

3 actions 3 updates phrasing extends openapi/deputy-area-rate-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 3

$.info
$.paths['/v2/area-rates/{employeeId}'].get
$.paths['/v2/area-rates:batch-save'].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 Area Rate API
  version: 1.0.0
extends: openapi/deputy-area-rate-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: 2
- target: $.paths['/v2/area-rates/{employeeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee's area rate
      effect: read
      questions:
      - What area rate is an employee paid at?
      - Can I see an employee's area rate as of a specific date?
      instructions:
      - text: Get the area rate for employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Show employee {employeeId}'s area rate effective {effectiveDate}.
        slots:
          employeeId: path.employeeId
          effectiveDate: query.effectiveDate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v2/area-rates:batch-save'].post
  update:
    x-apievangelist-phrasing:
      intent: Set area rates for several employees
      effect: write
      questions:
      - How do I set area rates for many employees at once?
      - Can I update several employees' area rates in one request?
      instructions:
      - text: Save area rates for employees {requests}.
        slots:
          requests: requestBody.requests
      - text: 'Batch update these employees'' area rates: {requests}.'
        slots:
          requests: requestBody.requests
      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-area-rate-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.