Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Country API
11 actions
11 updates
phrasing
extends
openapi/deputy-country-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/Country'].get
$.paths['/resource/Country/INFO'].get
$.paths['/resource/Country/PREDICT'].post
$.paths['/resource/Country/QUERY'].post
$.paths['/resource/Country/{id}'].get
$.paths['/resource/Country/{id}/COMMENTS'].get
$.paths['/resource/Country/{id}/COMMENTS'].post
$.paths['/resource/Country/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Country/{id}/HISTORY'].get
$.paths['/resource/Country/{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 Country API
version: 1.0.0
extends: openapi/deputy-country-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/Country'].get
update:
x-apievangelist-phrasing:
intent: List countries
effect: read
questions:
- Which countries are set up in Deputy?
- Can I get the full list of country records?
instructions:
- text: List all countries.
- text: Show every country record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Country/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get country field metadata
effect: read
questions:
- Which fields can I query on country records?
- What field types and associations does the Country resource have?
instructions:
- text: Get the field metadata for country records.
- text: Show which country fields are queryable.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Country/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing country by partial details
effect: read
questions:
- How do I find the existing country record that matches a country code?
- Can I match a new country to an existing one before creating it?
instructions:
- text: Predict the existing country record for code {code} and name {country}.
slots:
code: requestBody.Code
country: requestBody.Country
- text: Find the country matching code {code}, codeA3 {codeA3}, region {region} and name {country}.
slots:
code: requestBody.Code
codeA3: requestBody.CodeA3
region: requestBody.Region
country: requestBody.Country
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Country/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search countries
effect: read
questions:
- How do I find a country by its code?
- Can I sort and page through the country list?
instructions:
- text: Search countries where code is {code}.
slots:
code: requestBody.search
- text: Find countries matching {search}, sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Country/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a country by id
effect: read
questions:
- What are the details of a specific country?
- Can I fetch one country record by its id?
instructions:
- text: Get country {id}.
slots:
id: path.id
- text: Show the country record with id {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Country/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a country
effect: read
questions:
- What comments have been left on a country record?
- Can I see the discussion history on a country?
instructions:
- text: List comments on country {id}.
slots:
id: path.id
- text: Show the comments left on country {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Country/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a country
effect: write
questions:
- How do I annotate a country record with a note?
- Can I leave a comment on a country?
instructions:
- text: Comment {comment} on country {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: 'Add a note to country {id}: {comment}.'
slots:
id: path.id
comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Country/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a country
effect: destructive
questions:
- How do I remove a comment from a country?
- Can I delete a comment on a country record?
instructions:
- text: Delete comment {commentId} from country {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the comment {commentId} on country {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Country/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get a country's change history
effect: read
questions:
- What changes have been made to a country record?
- Can I see the edit history of a country?
instructions:
- text: Get the change history of country {id}.
slots:
id: path.id
- text: Show who changed country {id} and when.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Country/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: See a country as it was at a past time
effect: read
questions:
- How do I view a country record as it existed at a past moment?
- Can I travel back to a country's state before a change?
instructions:
- text: Show country {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to country {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-country-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.