Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Stress Profile API
17 actions
17 updates
phrasing
extends
openapi/deputy-stressprofile-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/StressProfile'].get
$.paths['/resource/StressProfile'].put
$.paths['/resource/StressProfile'].post
$.paths['/resource/StressProfile/BULK'].post
$.paths['/resource/StressProfile/INFO'].get
$.paths['/resource/StressProfile/PREDICT'].post
$.paths['/resource/StressProfile/QUERY'].post
$.paths['/resource/StressProfile/{id}'].get
$.paths['/resource/StressProfile/{id}'].put
$.paths['/resource/StressProfile/{id}'].post
$.paths['/resource/StressProfile/{id}'].delete
$.paths['/resource/StressProfile/{id}/COMMENTS'].get
$.paths['/resource/StressProfile/{id}/COMMENTS'].post
$.paths['/resource/StressProfile/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/StressProfile/{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 Stress Profile API
version: 1.0.0
extends: openapi/deputy-stressprofile-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/StressProfile'].get
update:
x-apievangelist-phrasing:
intent: List stress profiles
effect: read
questions:
- Which stress profiles are set up for my roster?
- Can I see all stress profiles at once?
instructions:
- text: List all stress profiles.
- text: Show every stress profile record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile'].put
update:
x-apievangelist-phrasing:
intent: Create a stress profile
effect: write
questions:
- How do I create a stress profile with a maximum shift length?
- Can I set a gap between shifts on a new stress profile?
instructions:
- text: Create stress profile {name} with max shift {max_hours_per_shift}.
slots:
name: requestBody.Name
max_hours_per_shift: requestBody.MaxHoursPerShift
- text: Create stress profile {name} with max shift {max_hours_per_shift} and gap {gap_hours}.
slots:
name: requestBody.Name
max_hours_per_shift: requestBody.MaxHoursPerShift
gap_hours: requestBody.GapHoursBetweenShifts
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile'].post
update:
x-apievangelist-phrasing:
intent: Create a stress profile (legacy POST)
effect: write
questions:
- Is there an older POST endpoint for creating stress profiles?
- Can I still create a stress profile with a legacy POST call?
instructions:
- text: Create a legacy stress profile {name} with max shift {max_hours_per_shift}.
slots:
name: requestBody.Name
max_hours_per_shift: requestBody.MaxHoursPerShift
- text: Use the older POST endpoint to create stress profile {name} with max shift {max_hours_per_shift} and gap {gap_hours}.
slots:
name: requestBody.Name
max_hours_per_shift: requestBody.MaxHoursPerShift
gap_hours: requestBody.GapHoursBetweenShifts
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/BULK'].post
update:
x-apievangelist-phrasing:
intent: Bulk create or update stress profiles
effect: write
questions:
- Can I create many stress profiles in one request?
- How do I update several stress profiles at once?
instructions:
- text: Bulk create or update these stress profiles.
- text: Process this array of stress profile records in one call.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get stress profile field metadata
effect: read
questions:
- Which fields can I query on stress profiles?
- What types and associations does the stress profile resource have?
instructions:
- text: Show the field metadata for stress profiles.
- text: List the queryable fields and associations for stress profiles.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing stress profile
effect: read
questions:
- Can I find the closest existing stress profile for a partial payload?
- Which stress profile would an upsert match to?
instructions:
- text: Predict-match stress profile {name} with max shift {max_hours_per_shift}.
slots:
name: requestBody.Name
max_hours_per_shift: requestBody.MaxHoursPerShift
- text: Find the existing stress profile matching {name}, shift {max_hours_per_shift} and gap {gap_hours}.
slots:
name: requestBody.Name
max_hours_per_shift: requestBody.MaxHoursPerShift
gap_hours: requestBody.GapHoursBetweenShifts
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search stress profiles
effect: read
questions:
- How do I find stress profiles matching a search?
- Can I sort and page stress profile search results?
instructions:
- text: Search stress profiles for {search}.
slots:
search: requestBody.search
- text: Find stress profiles matching {search}, sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a stress profile
effect: read
questions:
- What are the settings of one stress profile?
- Can I fetch a single stress profile by id?
instructions:
- text: Get stress profile {id}.
slots:
id: path.id
- text: Show the settings of stress profile {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/{id}'].put
update:
x-apievangelist-phrasing:
intent: Replace a stress profile
effect: write
questions:
- How do I overwrite a stress profile's settings?
- Can I fully replace a stress profile with a PUT call?
instructions:
- text: Replace stress profile {id} with name {name} and max shift {max_hours_per_shift}.
slots:
id: path.id
name: requestBody.Name
max_hours_per_shift: requestBody.MaxHoursPerShift
- text: Overwrite stress profile {id} with name {name}, shift {max_hours_per_shift} and gap {gap_hours}.
slots:
id: path.id
name: requestBody.Name
max_hours_per_shift: requestBody.MaxHoursPerShift
gap_hours: requestBody.GapHoursBetweenShifts
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update a stress profile
effect: write
questions:
- Can I change one field on a stress profile with a POST?
- How do I edit an existing stress profile?
instructions:
- text: Update stress profile {id} with name {name} and max shift {max_hours_per_shift}.
slots:
id: path.id
name: requestBody.Name
max_hours_per_shift: requestBody.MaxHoursPerShift
- text: Change the gap hours on stress profile {id} to {gap_hours}.
slots:
id: path.id
gap_hours: requestBody.GapHoursBetweenShifts
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a stress profile
effect: destructive
questions:
- How do I delete a stress profile?
- Can I remove a stress profile from the roster?
instructions:
- text: Delete stress profile {id}.
slots:
id: path.id
- text: Remove stress profile {id} from the roster.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a stress profile
effect: read
questions:
- What comments have been left on a stress profile?
- Can I see the comment history for a stress profile?
instructions:
- text: List comments on stress profile {id}.
slots:
id: path.id
- text: Show the comment history for stress profile {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Add a comment to a stress profile
effect: write
questions:
- How do I annotate a stress profile with a comment?
- Can I add a note to a stress profile?
instructions:
- text: Add comment {comment} to stress profile {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Annotate stress profile {id} with {comment}.
slots:
id: path.id
comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a stress profile
effect: destructive
questions:
- How do I delete a comment from a stress profile?
- Can I remove a comment on a stress profile?
instructions:
- text: Delete comment {comment_id} from stress profile {id}.
slots:
comment_id: path.commentId
id: path.id
- text: Remove comment {comment_id} on stress profile {id}.
slots:
comment_id: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history for a stress profile
effect: read
questions:
- What changes have been made to a stress profile over time?
- Can I see the edit history of a stress profile?
instructions:
- text: Show the change history of stress profile {id}.
slots:
id: path.id
- text: List every edit made to stress profile {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/StressProfile/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: Get a stress profile as it was at a past time
effect: read
questions:
- Can I see a stress profile as it existed at a past moment?
- What did a stress profile look like at a specific timestamp?
instructions:
- text: Get stress profile {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Show stress profile {id} as of {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-stressprofile-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.