Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource State API
11 actions
11 updates
phrasing
extends
openapi/deputy-state-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/State'].get
$.paths['/resource/State/INFO'].get
$.paths['/resource/State/PREDICT'].post
$.paths['/resource/State/QUERY'].post
$.paths['/resource/State/{id}'].get
$.paths['/resource/State/{id}/COMMENTS'].get
$.paths['/resource/State/{id}/COMMENTS'].post
$.paths['/resource/State/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/State/{id}/HISTORY'].get
$.paths['/resource/State/{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 State API
version: 1.0.0
extends: openapi/deputy-state-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/State'].get
update:
x-apievangelist-phrasing:
intent: List states
effect: read
questions:
- Which states exist in Deputy?
- Can I get every state record?
instructions:
- text: List all states.
- text: Show every state record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/State/INFO'].get
update:
x-apievangelist-phrasing:
intent: Describe the State resource
effect: read
questions:
- What fields does the State resource have?
- Which fields of State can I query?
instructions:
- text: Describe the State resource.
- text: List the queryable fields on State.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/State/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing state record
effect: read
questions:
- Can I find an existing state before creating it?
- How do I match a new state to an existing one?
instructions:
- text: Predict the existing state for country {country}, code {code}, state {state}, active {active}, created {created}, modified {modified}, creator {creator}.
slots:
country: requestBody.Country
code: requestBody.Code
state: requestBody.State
active: requestBody.Active
created: requestBody.Created
modified: requestBody.Modified
creator: requestBody.Creator
- text: Find the matching state for {country} with code {code} and name {state}.
slots:
country: requestBody.Country
code: requestBody.Code
state: requestBody.State
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/State/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search states
effect: read
questions:
- Can I search states by code?
- Which states match a search?
instructions:
- text: Search states where {search}.
slots:
search: requestBody.search
- text: Find states matching {search}, sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/State/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a state
effect: read
questions:
- What are the details of one state?
- Can I fetch a state by id?
instructions:
- text: Get state {id}.
slots:
id: path.id
- text: Show the details of state {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/State/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a state
effect: read
questions:
- What comments have been left on a state?
- Can I read the comments on a state?
instructions:
- text: List comments on state {id}.
slots:
id: path.id
- text: Show the comments left on state {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/State/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a state
effect: write
questions:
- Can I leave a comment on a state?
- How do I annotate a state record?
instructions:
- text: Comment {comment} on state {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Annotate state {id} with {comment}.
slots:
id: path.id
comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/State/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a state
effect: destructive
questions:
- Can I delete a comment on a state?
- How do I remove a comment from a state?
instructions:
- text: Delete comment {commentId} from state {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the comment {commentId} on state {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/State/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history for a state
effect: read
questions:
- What has changed on a state over time?
- Can I see the change history of a state?
instructions:
- text: Show the change history of state {id}.
slots:
id: path.id
- text: List the edits made to state {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/State/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: View a state as it was at a past time
effect: read
questions:
- Can I see a state as it looked at a past moment?
- What did a state record contain at a given timestamp?
instructions:
- text: Show state {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel state {id} back to {timestamp}.
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-state-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.