Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Category API
11 actions
11 updates
phrasing
extends
openapi/deputy-category-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 11
$.info
$.paths['/resource/Category'].get
$.paths['/resource/Category/INFO'].get
$.paths['/resource/Category/PREDICT'].post
$.paths['/resource/Category/QUERY'].post
$.paths['/resource/Category/{id}'].get
$.paths['/resource/Category/{id}/COMMENTS'].get
$.paths['/resource/Category/{id}/COMMENTS'].post
$.paths['/resource/Category/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Category/{id}/HISTORY'].get
$.paths['/resource/Category/{id}/HISTORY/travel/{timestamp}'].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 Category API
version: 1.0.0
extends: openapi/deputy-category-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: 10
- target: $.paths['/resource/Category'].get
update:
x-apievangelist-phrasing:
intent: List staff categories
effect: read
questions:
- What staff categories are set up in Deputy?
- Can I get the full list of category records?
instructions:
- text: List all staff categories.
- text: Show every category record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Category/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get staff category field metadata
effect: read
questions:
- Which fields and associations does the staff category resource have?
- What types are the category fields?
instructions:
- text: Show the field metadata for staff categories.
- text: List the queryable fields on the category resource.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Category/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing staff category
effect: read
questions:
- Can I find an existing staff category by name and group?
- What's the closest match for a new category?
instructions:
- text: Find the existing staff category with name {Category} in group {Group}.
slots:
Category: requestBody.Category
Group: requestBody.Group
- text: Predict-match a category named {Category} with sort order {SortOrder}.
slots:
Category: requestBody.Category
SortOrder: requestBody.SortOrder
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Category/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search staff categories
effect: read
questions:
- Can I search staff categories by name?
- How do I sort and page through categories?
instructions:
- text: Search staff categories where {search}.
slots:
search: requestBody.search
- text: Find categories matching {search} sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Category/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a staff category
effect: read
questions:
- What are the details of one staff category?
- Can I fetch a category by its id?
instructions:
- text: Get staff category {id}.
slots:
id: path.id
- text: Show the details of category {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Category/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a staff category
effect: read
questions:
- What comments have been left on a staff category?
- Can I read the discussion on a category?
instructions:
- text: List comments on staff category {id}.
slots:
id: path.id
- text: Show the comments on category {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Category/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a staff category
effect: write
questions:
- Can I add a comment to a staff category?
- How do I annotate a category record?
instructions:
- text: Add comment {Comment} to staff category {id}.
slots:
Comment: requestBody.Comment
id: path.id
- text: Comment on category {id} saying {Comment}.
slots:
id: path.id
Comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Category/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a staff category
effect: destructive
questions:
- Can I remove a comment from a staff category?
- How do I delete a comment on a category?
instructions:
- text: Delete comment {commentId} from staff category {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove category {id} comment {commentId}.
slots:
id: path.id
commentId: path.commentId
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Category/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history of a staff category
effect: read
questions:
- Who changed a staff category and when?
- Can I see the change history of a category?
instructions:
- text: Show the change history of staff category {id}.
slots:
id: path.id
- text: List edits made to category {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/Category/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: View a staff category as it was at a past time
effect: read
questions:
- Can I see a staff category as it looked at a past moment?
- What did a category record contain at a specific timestamp?
instructions:
- text: Show staff category {id} as it existed at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel to category {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-category-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.