Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Event API
17 actions
17 updates
phrasing
extends
openapi/deputy-event-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/Event'].get
$.paths['/resource/Event'].put
$.paths['/resource/Event'].post
$.paths['/resource/Event/BULK'].post
$.paths['/resource/Event/INFO'].get
$.paths['/resource/Event/PREDICT'].post
$.paths['/resource/Event/QUERY'].post
$.paths['/resource/Event/{id}'].get
$.paths['/resource/Event/{id}'].put
$.paths['/resource/Event/{id}'].post
$.paths['/resource/Event/{id}'].delete
$.paths['/resource/Event/{id}/COMMENTS'].get
$.paths['/resource/Event/{id}/COMMENTS'].post
$.paths['/resource/Event/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Event/{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 Event API
version: 1.0.0
extends: openapi/deputy-event-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/Event'].get
update:
x-apievangelist-phrasing:
intent: List event records
effect: read
questions:
- Which event records can I see in Deputy?
- Can I page through all events?
instructions:
- text: List my event records.
- text: Show every event record I am allowed to see.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event'].put
update:
x-apievangelist-phrasing:
intent: Create an event record
effect: write
questions:
- How do I create an event record with a known id?
- Can I replace an event record by its id?
instructions:
- text: Create event {id} with title {title}, schedule {schedule}, show on roster {show_on_roster}, modified {modified}.
slots:
id: requestBody.Id
title: requestBody.Title
schedule: requestBody.Schedule
show_on_roster: requestBody.ShowOnRoster
modified: requestBody.Modified
- text: Replace event {id} with schedule {schedule}, show on roster {show_on_roster}, modified {modified}.
slots:
id: requestBody.Id
schedule: requestBody.Schedule
show_on_roster: requestBody.ShowOnRoster
modified: requestBody.Modified
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event'].post
update:
x-apievangelist-phrasing:
intent: Create an event record
effect: write
questions:
- How do I create an event record with a schedule?
- Can I create an event that blocks time off?
instructions:
- text: Create an event with schedule {schedule}, show on roster {show_on_roster}, modified {modified}.
slots:
schedule: requestBody.Schedule
show_on_roster: requestBody.ShowOnRoster
modified: requestBody.Modified
- text: Add an event that blocks time off {block_time_off}.
slots:
block_time_off: requestBody.BlockTimeOff
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/BULK'].post
update:
x-apievangelist-phrasing:
intent: Create or update many events
effect: write
questions:
- Can I create or update several events in one request?
- How do I bulk upsert event records?
instructions:
- text: Bulk create or update these event records.
- text: Upsert a batch of events in one call.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get event field metadata
effect: read
questions:
- Which fields and types does an event record have?
- What associations exist on the event resource?
instructions:
- text: Show the field metadata for event records.
- text: List the event resource fields and their types.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing event for upserting
effect: read
questions:
- How do I find an existing event before creating it?
- Can I upsert an event by matching its schedule?
instructions:
- text: Predict-match an event with schedule {schedule}, show on roster {show_on_roster}, modified {modified}.
slots:
schedule: requestBody.Schedule
show_on_roster: requestBody.ShowOnRoster
modified: requestBody.Modified
- text: Find the existing event for upserting using schedule {schedule}.
slots:
schedule: requestBody.Schedule
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search event records
effect: read
questions:
- How do I find events by schedule?
- Can I sort and page through event records?
instructions:
- text: Search events matching {search}.
slots:
search: requestBody.search
- text: Find events 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/Event/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an event record
effect: read
questions:
- What schedule and colour does an event have?
- Can I fetch one event by id?
instructions:
- text: Get event {id}.
slots:
id: path.id
- text: Show the schedule and colour of event {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/{id}'].put
update:
x-apievangelist-phrasing:
intent: Create an event on a schedule
effect: write
questions:
- How do I add a new roster event for an employee?
- Can an event be set to block time off on the roster?
instructions:
- text: Replace event {id} with title {title} on schedule {schedule}.
slots:
id: path.id
title: requestBody.Title
schedule: requestBody.Schedule
- text: Add a new event {id} to schedule {schedule} with block time off {block}.
slots:
id: path.id
schedule: requestBody.Schedule
block: requestBody.BlockTimeOff
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update an event record
effect: write
questions:
- How do I change an event's title or colour?
- Can I update an event record by id?
instructions:
- text: Update event {id} with title {title}, schedule {schedule}, show on roster {show_on_roster}, modified {modified}.
slots:
id: path.id
title: requestBody.Title
schedule: requestBody.Schedule
show_on_roster: requestBody.ShowOnRoster
modified: requestBody.Modified
- text: Change the colour of event {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an event record
effect: destructive
questions:
- How do I delete an event record?
- Can I remove an event by id?
instructions:
- text: Delete event {id}.
slots:
id: path.id
- text: Remove event record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on an event
effect: read
questions:
- What comments have been left on an event?
- Can I read the discussion on an event?
instructions:
- text: List comments on event {id}.
slots:
id: path.id
- text: Show the discussion thread for event {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on an event
effect: write
questions:
- How do I add a comment to an event?
- Can I leave a note on an event record?
instructions:
- text: Comment {comment} on event {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Add a note to event {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on an event
effect: destructive
questions:
- How do I delete a comment from an event?
- Can I remove a note on an event?
instructions:
- text: Delete comment {commentId} from event {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the note {commentId} on event {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get an event's change history
effect: read
questions:
- Who changed an event and when?
- Can I see the change history of an event?
instructions:
- text: Show the change history of event {id}.
slots:
id: path.id
- text: List who edited event {id} and when.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Event/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: View an event as it was at a past time
effect: read
questions:
- How do I see an event as it looked before a change?
- Can I travel back to an event's state at a given time?
instructions:
- text: Show event {id} as it existed at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to event {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-event-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.