Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Employment Contract Config API
11 actions
11 updates
phrasing
extends
openapi/deputy-employmentcontractconfig-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/EmploymentContractConfig'].get
$.paths['/resource/EmploymentContractConfig/INFO'].get
$.paths['/resource/EmploymentContractConfig/PREDICT'].post
$.paths['/resource/EmploymentContractConfig/QUERY'].post
$.paths['/resource/EmploymentContractConfig/{id}'].get
$.paths['/resource/EmploymentContractConfig/{id}/COMMENTS'].get
$.paths['/resource/EmploymentContractConfig/{id}/COMMENTS'].post
$.paths['/resource/EmploymentContractConfig/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmploymentContractConfig/{id}/HISTORY'].get
$.paths['/resource/EmploymentContractConfig/{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 Employment Contract Config API
version: 1.0.0
extends: openapi/deputy-employmentcontractconfig-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/EmploymentContractConfig'].get
update:
x-apievangelist-phrasing:
intent: List employment contract templates
effect: read
questions:
- Which employment contract templates are available to me?
- Can I page through all employment contract templates?
instructions:
- text: List all employment contract templates.
- text: Show every employment contract template record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContractConfig/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get field metadata for contract templates
effect: read
questions:
- What fields and data types does an employment contract template record have?
- Which fields on contract templates can I query on?
instructions:
- text: Get the field metadata for employment contract templates.
- text: Show the types and associations of contract template fields.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContractConfig/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing contract template
effect: read
questions:
- Can I find an existing employment contract template matching a contract id and category?
- What does the prediction payload for a contract template need?
instructions:
- text: Predict the existing contract template for contract {ContractId} in category {Category} with status {Status}.
slots:
ContractId: requestBody.ContractId
Category: requestBody.Category
Status: requestBody.Status
- text: Find a contract template matching contract {ContractId}, category {Category}, status {Status} and modified {Modified}.
slots:
ContractId: requestBody.ContractId
Category: requestBody.Category
Status: requestBody.Status
Modified: requestBody.Modified
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContractConfig/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search employment contract templates
effect: read
questions:
- Can I search employment contract templates by contract id?
- How do I sort and page through contract templates?
instructions:
- text: Search employment contract templates matching {search}.
slots:
search: requestBody.search
- text: Find contract templates 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/EmploymentContractConfig/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an employment contract template
effect: read
questions:
- How do I look up one employment contract template by id?
- What does a single contract template record contain?
instructions:
- text: Get employment contract template {id}.
slots:
id: path.id
- text: Show the contract template with id {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContractConfig/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a contract template
effect: read
questions:
- What comments have been left on an employment contract template?
- Can I see the comment history for a contract template?
instructions:
- text: List comments on employment contract template {id}.
slots:
id: path.id
- text: Show the comment history for contract template {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContractConfig/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on an employment contract template
effect: write
questions:
- Can I add a comment to an employment contract template?
- How do I annotate a contract template?
instructions:
- text: Add comment {Comment} to employment contract template {id}.
slots:
Comment: requestBody.Comment
id: path.id
- text: Comment {Comment} on contract template {id}.
slots:
Comment: requestBody.Comment
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContractConfig/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a contract template
effect: destructive
questions:
- Can I remove a comment from an employment contract template?
- How do I delete a comment on a contract template?
instructions:
- text: Delete comment {commentId} from employment contract template {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove comment {commentId} on contract template {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContractConfig/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history for a contract template
effect: read
questions:
- What changes have been made to an employment contract template?
- Can I see the edit history of a contract template?
instructions:
- text: Get the change history of employment contract template {id}.
slots:
id: path.id
- text: Show every edit made to contract template {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmploymentContractConfig/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: See a contract template as it was at a past time
effect: read
questions:
- Can I view an employment contract template as it existed at a past moment?
- What did a contract template look like at a given timestamp?
instructions:
- text: Show employment contract template {id} as it existed at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel to contract template {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-employmentcontractconfig-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.