Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Training Module API
17 actions
17 updates
phrasing
extends
openapi/deputy-trainingmodule-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/TrainingModule'].get
$.paths['/resource/TrainingModule'].put
$.paths['/resource/TrainingModule'].post
$.paths['/resource/TrainingModule/BULK'].post
$.paths['/resource/TrainingModule/INFO'].get
$.paths['/resource/TrainingModule/PREDICT'].post
$.paths['/resource/TrainingModule/QUERY'].post
$.paths['/resource/TrainingModule/{id}'].get
$.paths['/resource/TrainingModule/{id}'].put
$.paths['/resource/TrainingModule/{id}'].post
$.paths['/resource/TrainingModule/{id}'].delete
$.paths['/resource/TrainingModule/{id}/COMMENTS'].get
$.paths['/resource/TrainingModule/{id}/COMMENTS'].post
$.paths['/resource/TrainingModule/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/TrainingModule/{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 Training Module API
version: 1.0.0
extends: openapi/deputy-trainingmodule-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/TrainingModule'].get
update:
x-apievangelist-phrasing:
intent: List training modules
effect: read
questions:
- What training modules are available to me?
- Can I page through the training module list?
instructions:
- text: List all training modules.
- text: Show every training module record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule'].put
update:
x-apievangelist-phrasing:
intent: Create or replace a training module
effect: write
questions:
- How do I create a training module record?
- Can I replace a training module by its id?
instructions:
- text: Create training module {id} titled {title} from {provider} taking {days} days.
slots:
id: requestBody.Id
title: requestBody.Title
provider: requestBody.Provider
days: requestBody.TimeRequiredDays
- text: Replace training module {id} with {title}, {provider}, {days} days, created by {creator}.
slots:
id: requestBody.Id
title: requestBody.Title
provider: requestBody.Provider
days: requestBody.TimeRequiredDays
creator: requestBody.Creator
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule'].post
update:
x-apievangelist-phrasing:
intent: Create a training module
effect: write
questions:
- How do I add a new training module for staff?
- Can I set a renewal period and cost on a training module?
instructions:
- text: Create training module {Title} with provider {Provider}, {TimeRequiredDays} days, comment {Comment}, modified {Modified}, id {Id}.
slots:
Title: requestBody.Title
Provider: requestBody.Provider
TimeRequiredDays: requestBody.TimeRequiredDays
Comment: requestBody.Comment
Modified: requestBody.Modified
Id: requestBody.Id
- text: Add training module {Title} from {Provider} costing {Cost} days {TimeRequiredDays} that needs a renewal every {RenewalPeriodMonths} months.
slots:
Title: requestBody.Title
Provider: requestBody.Provider
Cost: requestBody.Cost
TimeRequiredDays: requestBody.TimeRequiredDays
RenewalPeriodMonths: requestBody.RenewalPeriodMonths
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/BULK'].post
update:
x-apievangelist-phrasing:
intent: Create or update many training modules
effect: write
questions:
- Can I create or update several training modules in one call?
- How do I bulk upsert training modules?
instructions:
- text: Bulk create or update these training modules.
- text: Upsert this batch of training module records.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get training module field metadata
effect: read
questions:
- Which fields can I query on training modules?
- What field types and associations does the training module resource have?
instructions:
- text: Show the field metadata for training modules.
- text: List the queryable fields on training module records.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing training module
effect: read
questions:
- Can I find an existing training module before creating one?
- What record matches a training module title and provider?
instructions:
- text: Predict-match training module {id} titled {title} from {provider}.
slots:
id: requestBody.Id
title: requestBody.Title
provider: requestBody.Provider
- text: Find the closest training module to {id}, {title}, {provider}, {days}.
slots:
id: requestBody.Id
title: requestBody.Title
provider: requestBody.Provider
days: requestBody.TimeRequiredDays
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search training modules
effect: read
questions:
- How do I search training modules by title?
- Can I sort training modules and page through results?
instructions:
- text: Search training modules for {search}.
slots:
search: requestBody.search
- text: Find training modules matching {search}, sorted by {sort}, {max} at a time.
slots:
search: requestBody.search
sort: requestBody.sort
max: requestBody.max
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a training module
effect: read
questions:
- How do I look up one training module by id?
- What details are on a single training module?
instructions:
- text: Get training module {id}.
slots:
id: path.id
- text: Show the details of training module {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/{id}'].put
update:
x-apievangelist-phrasing:
intent: Replace a training module
effect: write
questions:
- How do I overwrite a training module record?
- Can I replace a training module's cost and renewal period?
instructions:
- text: Replace training module {id} with {title}, {provider}, {days} days.
slots:
id: path.id
title: requestBody.Title
provider: requestBody.Provider
days: requestBody.TimeRequiredDays
- text: Overwrite training module {id} with {title}, {provider}, {days} days, cost {cost}, renewal {months}.
slots:
id: path.id
title: requestBody.Title
provider: requestBody.Provider
days: requestBody.TimeRequiredDays
cost: requestBody.Cost
months: requestBody.RenewalPeriodMonths
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update a training module
effect: write
questions:
- How do I change an existing training module?
- Can I edit a training module's comment?
instructions:
- text: Update training module {id} with {title}, {provider}, {days} days.
slots:
id: path.id
title: requestBody.Title
provider: requestBody.Provider
days: requestBody.TimeRequiredDays
- text: Edit training module {id} to {title}, {provider}, {days} days, comment {comment}.
slots:
id: path.id
title: requestBody.Title
provider: requestBody.Provider
days: requestBody.TimeRequiredDays
comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a training module
effect: destructive
questions:
- How do I delete a training module?
- Can I remove a training module record?
instructions:
- text: Delete training module {id}.
slots:
id: path.id
- text: Remove training module {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a training module
effect: read
questions:
- What comments have been left on a training module?
- Can I read the discussion on a training module?
instructions:
- text: List comments on training module {id}.
slots:
id: path.id
- text: Show the discussion thread for training module {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a training module
effect: write
questions:
- How do I add a comment to a training module?
- Can I leave a note on a training module?
instructions:
- text: Add comment {comment} to training module {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Comment on training module {id} saying {comment}.
slots:
id: path.id
comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a training module
effect: destructive
questions:
- How do I remove a comment from a training module?
- Can I delete a comment on a training module?
instructions:
- text: Delete comment {commentId} from training module {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove comment {commentId} on training module {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get a training module's change history
effect: read
questions:
- What changes have been made to a training module?
- Can I see the edit history of a training module?
instructions:
- text: Show the change history of training module {id}.
slots:
id: path.id
- text: List edits made to training module {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/TrainingModule/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: View a training module at a past time
effect: read
questions:
- How do I see what a training module looked like at an earlier time?
- Can I travel back to a training module's state at a given timestamp?
instructions:
- text: Show training module {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to training module {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-trainingmodule-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.