Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Address API
17 actions
17 updates
phrasing
extends
openapi/deputy-address-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 17 · first 16 shown; the file carries all of them
$.info
$.paths['/resource/Address'].get
$.paths['/resource/Address'].put
$.paths['/resource/Address'].post
$.paths['/resource/Address/BULK'].post
$.paths['/resource/Address/INFO'].get
$.paths['/resource/Address/PREDICT'].post
$.paths['/resource/Address/QUERY'].post
$.paths['/resource/Address/{id}'].get
$.paths['/resource/Address/{id}'].put
$.paths['/resource/Address/{id}'].post
$.paths['/resource/Address/{id}'].delete
$.paths['/resource/Address/{id}/COMMENTS'].get
$.paths['/resource/Address/{id}/COMMENTS'].post
$.paths['/resource/Address/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Address/{id}/HISTORY'].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 Address API
version: 1.0.0
extends: openapi/deputy-address-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: 16
- target: $.paths['/resource/Address'].get
update:
x-apievangelist-phrasing:
intent: List address records
effect: read
questions:
- Which address records can I see?
- Can I page through the address table?
instructions:
- text: List all address records.
- text: Show every address record I have access to.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address'].put
update:
x-apievangelist-phrasing:
intent: Create or replace an address record
effect: write
questions:
- How do I create an address record with a PUT request?
- Can I replace an address record by its ID?
instructions:
- text: Create address record {Id} with name {ContactName} and phone {Phone}.
slots:
Id: requestBody.Id
ContactName: requestBody.ContactName
Phone: requestBody.Phone
- text: Replace address {Id} with street {Street1} and postcode {Postcode}.
slots:
Id: requestBody.Id
Street1: requestBody.Street1
Postcode: requestBody.Postcode
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address'].post
update:
x-apievangelist-phrasing:
intent: Create an address record
effect: write
questions:
- Can I create a new address record with a POST request?
- What fields does a new address record need?
instructions:
- text: Create a new address record {Id} with contact {ContactName}.
slots:
Id: requestBody.Id
ContactName: requestBody.ContactName
- text: Add a new address {Id} at {Street1}, {City}.
slots:
Id: requestBody.Id
Street1: requestBody.Street1
City: requestBody.City
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/BULK'].post
update:
x-apievangelist-phrasing:
intent: Create or update many address records
effect: write
questions:
- Can I create or update several address records in one request?
- How do I upsert a batch of addresses?
instructions:
- text: Bulk upsert these address records.
- text: Create or update many addresses at once.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get address field metadata
effect: read
questions:
- Which fields can I query on an address record?
- What field types and associations does the address resource have?
instructions:
- text: Show the field metadata for address records.
- text: List the address fields and their types.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing address for upserting
effect: read
questions:
- Can I find an existing address before creating a duplicate?
- Which fields does the upsert prediction use?
instructions:
- text: Predict-match an existing address for {Id}.
slots:
Id: requestBody.Id
- text: Find the closest existing address for {ContactName} at {Street1}.
slots:
ContactName: requestBody.ContactName
Street1: requestBody.Street1
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search address records
effect: read
questions:
- How do I search addresses by postcode?
- Can I sort and page address search results?
instructions:
- text: Search addresses where postcode is {Postcode}.
slots:
Postcode: requestBody.search
- text: Find addresses matching {search}, sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an address record
effect: read
questions:
- What details are stored on one address record?
- Can I fetch an address by its ID?
instructions:
- text: Get address record {id}.
slots:
id: path.id
- text: Show the address with ID {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/{id}'].put
update:
x-apievangelist-phrasing:
intent: Replace an address record
effect: write
questions:
- How do I overwrite an existing address record?
- Can I replace an address record with a PUT request?
instructions:
- text: Replace address {id} with name {ContactName} and phone {Phone}.
slots:
id: path.id
ContactName: requestBody.ContactName
Phone: requestBody.Phone
- text: Overwrite address {id} at {Street1}, {City}.
slots:
id: path.id
Street1: requestBody.Street1
City: requestBody.City
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update an address record
effect: write
questions:
- Can I update an existing address record with a POST request?
- What fields can I change on an address?
instructions:
- text: Update address {id} with contact {ContactName}.
slots:
id: path.id
ContactName: requestBody.ContactName
- text: Change the postcode on address {id} to {Postcode}.
slots:
id: path.id
Postcode: requestBody.Postcode
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an address record
effect: destructive
questions:
- How do I delete an address record?
- Can I remove an address by its ID?
instructions:
- text: Delete address record {id}.
slots:
id: path.id
- text: Remove the address with ID {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on an address
effect: read
questions:
- What comments have been left on an address?
- Can I see the comment history for an address?
instructions:
- text: List comments on address {id}.
slots:
id: path.id
- text: Show the comment history for address {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Add a comment to an address
effect: write
questions:
- How do I add a comment to an address record?
- Can I annotate an address with a note?
instructions:
- text: Add comment {Comment} to address {id}.
slots:
Comment: requestBody.Comment
id: path.id
- text: Comment {Comment} on address {id}.
slots:
Comment: requestBody.Comment
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on an address
effect: destructive
questions:
- How do I remove a comment from an address?
- Can I delete a single comment on an address?
instructions:
- text: Delete comment {commentId} from address {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the comment {commentId} on address {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history for an address
effect: read
questions:
- What changes have been made to an address record?
- Can I see the edit history of an address?
instructions:
- text: Show the change history of address {id}.
slots:
id: path.id
- text: List every edit made to address {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Address/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: Get an address as it was at a past time
effect: read
questions:
- Can I see what an address looked like at a previous point in time?
- How do I travel back to an address's state at a given timestamp?
instructions:
- text: Show address {id} as it existed at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to address {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-address-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.