Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Kiosk API

11 actions 11 updates phrasing extends openapi/deputy-kiosk-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/resource/Kiosk'].get
$.paths['/resource/Kiosk/INFO'].get
$.paths['/resource/Kiosk/PREDICT'].post
$.paths['/resource/Kiosk/QUERY'].post
$.paths['/resource/Kiosk/{id}'].get
$.paths['/resource/Kiosk/{id}/COMMENTS'].get
$.paths['/resource/Kiosk/{id}/COMMENTS'].post
$.paths['/resource/Kiosk/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Kiosk/{id}/HISTORY'].get
$.paths['/resource/Kiosk/{id}/HISTORY/travel/{timestamp}'].get

OpenAPI Overlay

Raw ↑
# 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 Kiosk API
  version: 1.0.0
extends: openapi/deputy-kiosk-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/Kiosk'].get
  update:
    x-apievangelist-phrasing:
      intent: List kiosk records
      effect: read
      questions:
      - Which kiosks are set up in my company?
      - Can I see all kiosk records I have access to?
      instructions:
      - text: List all kiosk records.
      - text: Show every kiosk in the company.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Kiosk/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get kiosk field metadata
      effect: read
      questions:
      - What fields and types does a kiosk record have?
      - Which kiosk fields can I query or sort on?
      instructions:
      - text: Get the field metadata for kiosk records.
      - text: Show which kiosk fields are queryable.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Kiosk/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing kiosk by partial details
      effect: read
      questions:
      - How do I find the existing kiosk record that matches a partial payload?
      - Can I predict a kiosk by name, installation ID and connection mode?
      instructions:
      - text: Predict the kiosk record matching name {Name}, installation ID {InstallationId}, connection mode {ConnectionMode} and company {Company}.
        slots:
          Name: requestBody.Name
          InstallationId: requestBody.InstallationId
          ConnectionMode: requestBody.ConnectionMode
          Company: requestBody.Company
      - text: Find the existing kiosk for {Name} ({InstallationId}, {ConnectionMode}, {Company}).
        slots:
          Name: requestBody.Name
          InstallationId: requestBody.InstallationId
          ConnectionMode: requestBody.ConnectionMode
          Company: requestBody.Company
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Kiosk/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search kiosk records
      effect: read
      questions:
      - How do I find kiosks by a field value?
      - Can I sort kiosk search results and page through them?
      instructions:
      - text: Search kiosk records where {search}.
        slots:
          search: requestBody.search
      - text: Find kiosks matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Kiosk/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a kiosk record
      effect: read
      questions:
      - What are the details of one kiosk?
      - Can I fetch a kiosk by its ID?
      instructions:
      - text: Get kiosk {id}.
        slots:
          id: path.id
      - text: Show the details of kiosk {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Kiosk/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a kiosk
      effect: read
      questions:
      - What comments have been left on a kiosk?
      - Can I see the comment history for a kiosk?
      instructions:
      - text: List comments on kiosk {id}.
        slots:
          id: path.id
      - text: Show the comment history for kiosk {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Kiosk/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a kiosk
      effect: write
      questions:
      - How do I add a comment to a kiosk?
      - Can I leave a note on a kiosk record?
      instructions:
      - text: Add comment {Comment} to kiosk {id}.
        slots:
          Comment: requestBody.Comment
          id: path.id
      - text: Comment kiosk {id} saying {Comment}.
        slots:
          id: path.id
          Comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Kiosk/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a kiosk
      effect: destructive
      questions:
      - How do I remove a comment from a kiosk?
      - Can I delete a single comment on a kiosk?
      instructions:
      - text: Delete comment {commentId} from kiosk {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove kiosk {id}'s comment {commentId}.
        slots:
          id: path.id
          commentId: path.commentId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Kiosk/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history for a kiosk
      effect: read
      questions:
      - Who changed a kiosk and when?
      - Can I see the full change history of a kiosk?
      instructions:
      - text: Get the change history of kiosk {id}.
        slots:
          id: path.id
      - text: Show every change made to kiosk {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Kiosk/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: See a kiosk as it was at a past time
      effect: read
      questions:
      - How do I see what a kiosk looked like at a specific moment?
      - Can I travel back to a kiosk's state at a given timestamp?
      instructions:
      - text: Show kiosk {id} as it existed at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to kiosk {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.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-kiosk-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.