Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource System Usage Balance API
11 actions
11 updates
phrasing
extends
openapi/deputy-systemusagebalance-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/resource/SystemUsageBalance'].get
$.paths['/resource/SystemUsageBalance/INFO'].get
$.paths['/resource/SystemUsageBalance/PREDICT'].post
$.paths['/resource/SystemUsageBalance/QUERY'].post
$.paths['/resource/SystemUsageBalance/{id}'].get
$.paths['/resource/SystemUsageBalance/{id}/COMMENTS'].get
$.paths['/resource/SystemUsageBalance/{id}/COMMENTS'].post
$.paths['/resource/SystemUsageBalance/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/SystemUsageBalance/{id}/HISTORY'].get
$.paths['/resource/SystemUsageBalance/{id}/HISTORY/travel/{timestamp}'].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 Deputy V1 Resource System Usage Balance API
version: 1.0.0
extends: openapi/deputy-systemusagebalance-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: 10
- target: $.paths['/resource/SystemUsageBalance'].get
update:
x-apievangelist-phrasing:
intent: List system usage balance records
effect: read
questions:
- What system usage balance records do I have access to?
- Can I page through system usage balance entries?
instructions:
- text: List my system usage balance records.
- text: Show every system usage balance entry.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SystemUsageBalance/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get system usage balance field metadata
effect: read
questions:
- Which fields can I query on system usage balance?
- What types and associations does system usage balance have?
instructions:
- text: Show the field metadata for system usage balance.
- text: List the queryable fields and their types for system usage balance.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SystemUsageBalance/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing system usage balance record
effect: read
questions:
- How do I find the existing system usage balance record for a partial entry?
- Can I predict-match a system usage balance by date and credit?
instructions:
- text: Predict-match a system usage balance for {Id} of type {Type} on {Date} with credit {Credit}.
slots:
Id: requestBody.Id
Type: requestBody.Type
Date: requestBody.Date
Credit: requestBody.Credit
- text: Find the closest existing system usage balance for {Id}, {Type}, {Date}, {Credit}, described as {Description}.
slots:
Id: requestBody.Id
Type: requestBody.Type
Date: requestBody.Date
Credit: requestBody.Credit
Description: requestBody.Description
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SystemUsageBalance/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search system usage balance records
effect: read
questions:
- Can I search system usage balance by a field value?
- How do I sort and page system usage balance results?
instructions:
- text: Search system usage balance where {search}.
slots:
search: requestBody.search
- text: Find system usage balance sorted by {sort}, {max} at a time.
slots:
sort: requestBody.sort
max: requestBody.max
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SystemUsageBalance/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a system usage balance record
effect: read
questions:
- What are the details of one system usage balance record?
- Can I fetch a single system usage balance by id?
instructions:
- text: Get system usage balance {id}.
slots:
id: path.id
- text: Show the system usage balance record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SystemUsageBalance/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a system usage balance record
effect: read
questions:
- What comments have been left on a system usage balance record?
- Can I see the comment history for a system usage balance?
instructions:
- text: List comments on system usage balance {id}.
slots:
id: path.id
- text: Show the comment history for system usage balance {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SystemUsageBalance/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a system usage balance record
effect: write
questions:
- How do I add a comment to a system usage balance record?
- Can I annotate a system usage balance entry?
instructions:
- text: Comment {Comment} on system usage balance {id}.
slots:
Comment: requestBody.Comment
id: path.id
- text: Add a note {Comment} to system usage balance {id}.
slots:
Comment: requestBody.Comment
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SystemUsageBalance/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a system usage balance record
effect: destructive
questions:
- Can I remove a comment from a system usage balance record?
- What's the way to delete a comment on a system usage balance?
instructions:
- text: Delete comment {commentId} from system usage balance {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the comment {commentId} on system usage balance {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SystemUsageBalance/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history of a system usage balance record
effect: read
questions:
- Who changed a system usage balance record and when?
- Can I see the full change history of a system usage balance?
instructions:
- text: Show the change history of system usage balance {id}.
slots:
id: path.id
- text: List every change made to system usage balance {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SystemUsageBalance/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: View a system usage balance record as it was at a past time
effect: read
questions:
- What did a system usage balance record look like at a specific past moment?
- Can I travel back to a system usage balance record as it existed at a timestamp?
instructions:
- text: Show system usage balance {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to system usage balance {id} at {timestamp} and show it.
slots:
id: path.id
timestamp: path.timestamp
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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-systemusagebalance-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.