Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 My Setup API

13 actions 13 updates phrasing extends openapi/deputy-setup-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 13

$.info
$.paths['/my/setup'].get
$.paths['/my/setup/addNewWorkplace'].post
$.paths['/my/setup/apps'].get
$.paths['/my/setup/gamingfy/{action}'].get
$.paths['/my/setup/gamingfy/{action}'].post
$.paths['/my/setup/getAddressTimezoneFromGeo'].post
$.paths['/my/setup/getGeoTimezoneFromAddress'].post
$.paths['/my/setup/getStateCountryList'].get
$.paths['/my/setup/sendEmailToCX'].post
$.paths['/my/setup/sf'].post
$.paths['/my/setup/supportAccess'].get
$.paths['/my/setup/validateWorkplace'].post

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 My Setup API
  version: 1.0.0
extends: openapi/deputy-setup-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: 12
- target: $.paths['/my/setup'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my setup
      effect: read
      questions:
      - What setup does the current user have?
      - Can I see my own setup details?
      instructions:
      - text: Show my setup.
      - text: Get the setup for the logged-in user.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/my/setup/addNewWorkplace'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new workplace
      effect: write
      questions:
      - How do I add a new workplace to my setup?
      - Can I create a workplace through the API?
      instructions:
      - text: Add a new workplace to my setup.
      - text: Create a workplace in my setup.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/my/setup/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List my user setup apps
      effect: read
      questions:
      - Which setup apps are available to me?
      - What apps can I connect from my user settings?
      instructions:
      - text: List my setup apps.
      - text: Show the apps I can configure in my user setup.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/my/setup/gamingfy/{action}'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a gamingfy action
      effect: read
      questions:
      - Can I trigger a gamingfy action through the API?
      - What does the gamingfy action do?
      instructions:
      - text: Run gamingfy action {action}.
        slots:
          action: path.action
      - text: Trigger the {action} gamingfy action.
        slots:
          action: path.action
      method: generated
      generated: '2026-11-17'
- target: $.paths['/my/setup/gamingfy/{action}'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a gamingfy action
      effect: write
      questions:
      - How do I submit a gamingfy action?
      - Can I post a gamingfy action through the API?
      instructions:
      - text: Submit gamingfy action {action}.
        slots:
          action: path.action
      - text: Post the {action} gamingfy action.
        slots:
          action: path.action
      method: generated
      generated: '2026-11-17'
- target: $.paths['/my/setup/getAddressTimezoneFromGeo'].post
  update:
    x-apievangelist-phrasing:
      intent: Get timezone from coordinates
      effect: read
      questions:
      - How do I find the timezone for a latitude and longitude?
      - Can I get a timezone from geo coordinates?
      instructions:
      - text: Get the timezone from these coordinates.
      - text: Find the timezone for a latitude and longitude.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/my/setup/getGeoTimezoneFromAddress'].post
  update:
    x-apievangelist-phrasing:
      intent: Get timezone from an address
      effect: read
      questions:
      - What timezone does an address fall in?
      - Can I get a timezone from a street address?
      instructions:
      - text: Get the timezone for this address.
      - text: Find the timezone of an address.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/my/setup/getStateCountryList'].get
  update:
    x-apievangelist-phrasing:
      intent: List states and countries
      effect: read
      questions:
      - Which states and countries are available for setup?
      - What state and country list does the setup use?
      instructions:
      - text: List the states and countries for setup.
      - text: Show the setup state and country list.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/my/setup/sendEmailToCX'].post
  update:
    x-apievangelist-phrasing:
      intent: Email customer support
      effect: write
      questions:
      - How do I email customer support from my setup?
      - Can I send a message to support through the API?
      instructions:
      - text: Email customer support from my setup.
      - text: Send a message to support through setup.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/my/setup/sf'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a setup form
      effect: write
      questions:
      - How do I submit a setup form?
      - Can I post a setup form through the API?
      instructions:
      - text: Submit a setup form.
      - text: Send the setup form.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/my/setup/supportAccess'].get
  update:
    x-apievangelist-phrasing:
      intent: Get support access
      effect: read
      questions:
      - What support access does my setup have?
      - Can I check my support access details?
      instructions:
      - text: Show my support access.
      - text: Get the support access for the logged-in user.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/my/setup/validateWorkplace'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a workplace
      effect: write
      questions:
      - How do I validate a workplace?
      - Can I check a workplace is valid?
      instructions:
      - text: Validate this workplace.
      - text: Check the workplace is valid.
      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-setup-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.