Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Custom App Data API
11 actions
11 updates
phrasing
extends
openapi/deputy-customappdata-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/CustomAppData'].get
$.paths['/resource/CustomAppData/INFO'].get
$.paths['/resource/CustomAppData/PREDICT'].post
$.paths['/resource/CustomAppData/QUERY'].post
$.paths['/resource/CustomAppData/{id}'].get
$.paths['/resource/CustomAppData/{id}/COMMENTS'].get
$.paths['/resource/CustomAppData/{id}/COMMENTS'].post
$.paths['/resource/CustomAppData/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/CustomAppData/{id}/HISTORY'].get
$.paths['/resource/CustomAppData/{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 Custom App Data API
version: 1.0.0
extends: openapi/deputy-customappdata-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/CustomAppData'].get
update:
x-apievangelist-phrasing:
intent: List custom app data records
effect: read
questions:
- What custom app data records can my integration see?
- Is there a large table of custom app data I should query with POST instead of GET?
instructions:
- text: List all custom app data records.
- text: Show every custom app data record I have access to.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomAppData/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get custom app data field metadata
effect: read
questions:
- Which fields and types exist on custom app data records?
- What associations does the custom app data resource have?
instructions:
- text: Get the field metadata for custom app data.
- text: Show which custom app data fields are queryable.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomAppData/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing custom app data record
effect: read
questions:
- Can I find an existing custom app data record from a partial payload before creating it?
- Which fields does the custom app data predict-match endpoint need?
instructions:
- text: Predict-match custom app data for document {DocumentId} with data {Data} and modified {Modified}.
slots:
DocumentId: requestBody.DocumentId
Data: requestBody.Data
Modified: requestBody.Modified
- text: Find the existing custom app data record for {Id}.
slots:
Id: requestBody.Id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomAppData/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search custom app data records
effect: read
questions:
- How do I search custom app data records with filters and sorting?
- Can I sort custom app data results and page through them?
instructions:
- text: Search custom app data matching {search}.
slots:
search: requestBody.search
- text: Find custom app data sorted by {sort}, {max} at a time.
slots:
sort: requestBody.sort
max: requestBody.max
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomAppData/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a custom app data record
effect: read
questions:
- What data is stored in a specific custom app data record?
- Can I fetch one custom app data record by its id?
instructions:
- text: Get custom app data record {id}.
slots:
id: path.id
- text: Show the data in custom app data {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomAppData/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on custom app data
effect: read
questions:
- What comments have been left on a custom app data record?
- Can I see the comment history for a custom app data record?
instructions:
- text: List comments on custom app data {id}.
slots:
id: path.id
- text: Show the comment history for custom app data {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomAppData/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a custom app data record
effect: write
questions:
- How do I leave a comment on a custom app data record?
- Can I add a comment to a custom app data record?
instructions:
- text: Comment {Comment} on custom app data {id}.
slots:
Comment: requestBody.Comment
id: path.id
- text: Add a comment to custom app data {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomAppData/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on custom app data
effect: destructive
questions:
- How do I delete a comment from a custom app data record?
- Can I remove a single comment on custom app data?
instructions:
- text: Delete comment {commentId} from custom app data {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove comment {commentId} on custom app data {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomAppData/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history for custom app data
effect: read
questions:
- What changes have been made to a custom app data record over time?
- Can I see the full change history of custom app data?
instructions:
- text: Get the change history of custom app data {id}.
slots:
id: path.id
- text: Show every change made to custom app data {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomAppData/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: See custom app data as it was at a past time
effect: read
questions:
- Can I view a custom app data record as it existed at a past moment?
- What did custom app data look like at a given timestamp?
instructions:
- text: Show custom app data {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to custom app data {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-customappdata-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.