Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Sales Data API
17 actions
17 updates
phrasing
extends
openapi/deputy-salesdata-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/SalesData'].get
$.paths['/resource/SalesData'].put
$.paths['/resource/SalesData'].post
$.paths['/resource/SalesData/BULK'].post
$.paths['/resource/SalesData/INFO'].get
$.paths['/resource/SalesData/PREDICT'].post
$.paths['/resource/SalesData/QUERY'].post
$.paths['/resource/SalesData/{id}'].get
$.paths['/resource/SalesData/{id}'].put
$.paths['/resource/SalesData/{id}'].post
$.paths['/resource/SalesData/{id}'].delete
$.paths['/resource/SalesData/{id}/COMMENTS'].get
$.paths['/resource/SalesData/{id}/COMMENTS'].post
$.paths['/resource/SalesData/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/SalesData/{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 Sales Data API
version: 1.0.0
extends: openapi/deputy-salesdata-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/SalesData'].get
update:
x-apievangelist-phrasing:
intent: List sales data records
effect: read
questions:
- What sales data has been recorded in Deputy?
- Can I page through the sales data table?
instructions:
- text: List all sales data records.
- text: Show every sales record in the table.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData'].put
update:
x-apievangelist-phrasing:
intent: Create or replace a sales data record
effect: write
questions:
- How do I upsert a sales record by its ID?
- Can I overwrite an existing sales data record?
instructions:
- text: Create or replace sales data {id} for operational unit {operational_unit} with reference {ref}.
slots:
id: requestBody.Id
operational_unit: requestBody.OperationalUnit
ref: requestBody.SalesRef
- text: Upsert sales record {id} with amount {amount} and modified {modified}.
slots:
id: requestBody.Id
amount: requestBody.SalesAmount
modified: requestBody.Modified
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData'].post
update:
x-apievangelist-phrasing:
intent: Create a sales data record
effect: write
questions:
- How do I add a new sales record?
- What fields are required to create a sales data record?
instructions:
- text: Create a new sales data record for {operational_unit} with reference {ref}.
slots:
operational_unit: requestBody.OperationalUnit
ref: requestBody.SalesRef
- text: Add a new sales record for employee {employee} on {date}.
slots:
employee: requestBody.Employee
date: requestBody.Date
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/BULK'].post
update:
x-apievangelist-phrasing:
intent: Create or update many sales data records
effect: write
questions:
- Can I import a batch of sales data at once?
- How do I upsert many sales records in one request?
instructions:
- text: Bulk upsert these sales data records.
- text: Import a batch of sales records in one call.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get sales data field metadata
effect: read
questions:
- Which fields can I query on sales data?
- What associations does the sales data resource have?
instructions:
- text: Show the field metadata for sales data.
- text: List the queryable fields and associations of sales data.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing sales record by partial match
effect: read
questions:
- Can I find the closest existing sales record for a partial payload?
- Which sales record already exists for a given reference?
instructions:
- text: Predict-match sales data {id} for operational unit {operational_unit} with reference {ref}.
slots:
id: requestBody.Id
operational_unit: requestBody.OperationalUnit
ref: requestBody.SalesRef
- text: Find the existing sales record matching {ref} in {operational_unit}.
slots:
ref: requestBody.SalesRef
operational_unit: requestBody.OperationalUnit
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search sales data
effect: read
questions:
- How do I find sales records by reference?
- Can I sort and page through sales data?
instructions:
- text: Search sales data for reference {ref}.
slots:
ref: requestBody.search
- text: Find sales records matching {ref} sorted by {sort}.
slots:
ref: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a sales data record
effect: read
questions:
- What does a specific sales data record contain?
- Can I fetch one sales record by its ID?
instructions:
- text: Get sales data record {id}.
slots:
id: path.id
- text: Show the sales record with ID {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/{id}'].put
update:
x-apievangelist-phrasing:
intent: Replace a sales data record
effect: write
questions:
- How do I overwrite an existing sales record?
- Can I fully replace a sales data record by ID?
instructions:
- text: Replace sales data record {id} with reference {ref}.
slots:
id: path.id
ref: requestBody.SalesRef
- text: Overwrite sales record {id} for operational unit {operational_unit}.
slots:
id: path.id
operational_unit: requestBody.OperationalUnit
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update a sales data record
effect: write
questions:
- How do I change the amount on an existing sales record?
- Can I edit a sales data record without replacing it?
instructions:
- text: Update sales data record {id} with amount {amount}.
slots:
id: path.id
amount: requestBody.SalesAmount
- text: Change the reference on sales record {id} to {ref}.
slots:
id: path.id
ref: requestBody.SalesRef
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a sales data record
effect: destructive
questions:
- How do I delete a sales record?
- Can I remove a sales data record by ID?
instructions:
- text: Delete sales data record {id}.
slots:
id: path.id
- text: Remove the sales record with ID {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a sales record
effect: read
questions:
- What comments have been left on a sales record?
- Can I see the comment history for a sales data record?
instructions:
- text: List comments on sales data record {id}.
slots:
id: path.id
- text: Show the comment history for sales record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a sales record
effect: write
questions:
- How do I add a comment to a sales data record?
- Can I annotate a sales record with a note?
instructions:
- text: Add comment {comment} to sales data record {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Comment {comment} on sales record {id}.
slots:
comment: requestBody.Comment
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a sales record
effect: destructive
questions:
- How do I remove a comment from a sales record?
- Can I delete a single comment on a sales data record?
instructions:
- text: Delete comment {comment_id} from sales data record {id}.
slots:
comment_id: path.commentId
id: path.id
- text: Remove comment {comment_id} on sales record {id}.
slots:
comment_id: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history for a sales record
effect: read
questions:
- What changes have been made to a sales data record?
- Can I see the edit history of a sales record?
instructions:
- text: Show the change history of sales data record {id}.
slots:
id: path.id
- text: List the edits made to sales record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/SalesData/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: Get a sales record as it was at a past time
effect: read
questions:
- Can I see a sales record as it existed at a past time?
- How do I travel back to an earlier version of a sales data record?
instructions:
- text: Get sales data record {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to sales record {id} at {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-salesdata-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.