Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Task Group Setup API

17 actions 17 updates phrasing extends openapi/deputy-taskgroupsetup-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 17 · first 16 shown; the file carries all of them

$.info
$.paths['/resource/TaskGroupSetup'].get
$.paths['/resource/TaskGroupSetup'].put
$.paths['/resource/TaskGroupSetup'].post
$.paths['/resource/TaskGroupSetup/BULK'].post
$.paths['/resource/TaskGroupSetup/INFO'].get
$.paths['/resource/TaskGroupSetup/PREDICT'].post
$.paths['/resource/TaskGroupSetup/QUERY'].post
$.paths['/resource/TaskGroupSetup/{id}'].get
$.paths['/resource/TaskGroupSetup/{id}'].put
$.paths['/resource/TaskGroupSetup/{id}'].post
$.paths['/resource/TaskGroupSetup/{id}'].delete
$.paths['/resource/TaskGroupSetup/{id}/COMMENTS'].get
$.paths['/resource/TaskGroupSetup/{id}/COMMENTS'].post
$.paths['/resource/TaskGroupSetup/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/TaskGroupSetup/{id}/HISTORY'].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 Task Group Setup API
  version: 1.0.0
extends: openapi/deputy-taskgroupsetup-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: 16
- target: $.paths['/resource/TaskGroupSetup'].get
  update:
    x-apievangelist-phrasing:
      intent: List task group setup records
      effect: read
      questions:
      - Which task group setups are configured in my Deputy account?
      - Can I page through the task group setup table?
      instructions:
      - text: List all task group setup records.
      - text: Show every task group setup configured in the account.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a task group setup
      effect: write
      questions:
      - How do I create a task group setup that tracks a recurring checklist?
      - Can I replace a task group setup record in one call?
      instructions:
      - text: Create task group setup {key} named {name} with active {active} and creator {creator}.
        slots:
          key: requestBody.Key
          name: requestBody.Name
          active: requestBody.Active
          creator: requestBody.Creator
      - text: Replace the existing task group setup {key} with a new record.
        slots:
          key: requestBody.Key
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task group setup
      effect: write
      questions:
      - How do I define a recurring task group setup for my workforce?
      - Can a task group setup be made compulsory or set a deadline?
      instructions:
      - text: Create a task group setup called {name} with key {key}.
        slots:
          name: requestBody.Name
          key: requestBody.Key
      - text: Set up task group {key} named {name} with creator {creator}.
        slots:
          key: requestBody.Key
          name: requestBody.Name
          creator: requestBody.Creator
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update task group setups in bulk
      effect: write
      questions:
      - Can I create many task group setups at once?
      - How do I update several task group setups in one request?
      instructions:
      - text: Bulk create or update these task group setups.
      - text: Apply this batch of task group setup records.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get task group setup field metadata
      effect: read
      questions:
      - Which fields can I query on task group setups?
      - What types and associations does the task group setup resource have?
      instructions:
      - text: Show the field metadata for task group setups.
      - text: List the queryable fields and their types for task group setup.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing task group setup by partial data
      effect: read
      questions:
      - Can I find the existing task group setup that matches a partial payload?
      - Which task group setup record is the closest match for a new one?
      instructions:
      - text: Predict the existing task group setup matching {key}.
        slots:
          key: requestBody.Key
      - text: Find the closest task group setup for {key} named {name}.
        slots:
          key: requestBody.Key
          name: requestBody.Name
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search task group setups
      effect: read
      questions:
      - How do I find task group setups by name or key?
      - Can I sort and page through task group setup search results?
      instructions:
      - text: Search task group setups where {search}.
        slots:
          search: requestBody.search
      - text: Find task group setups matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task group setup
      effect: read
      questions:
      - What are the details of one task group setup?
      - Can I fetch a single task group setup by id?
      instructions:
      - text: Get task group setup {id}.
        slots:
          id: path.id
      - text: Show the details of task group setup {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a task group setup
      effect: write
      questions:
      - How do I overwrite a task group setup record completely?
      - Can I fully replace a task group setup with a new record?
      instructions:
      - text: Replace task group setup {id} with {key}, {name}, active {active}, creator {creator}.
        slots:
          id: path.id
          key: requestBody.Key
          name: requestBody.Name
          active: requestBody.Active
          creator: requestBody.Creator
      - text: Overwrite the whole task group setup {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a task group setup
      effect: write
      questions:
      - How do I change the deadline on an existing task group setup?
      - Can I mark an existing task group setup as inactive?
      instructions:
      - text: Update task group setup {id} to active {active}.
        slots:
          id: path.id
          active: requestBody.Active
      - text: Set the deadline on task group setup {id} to {deadline}.
        slots:
          id: path.id
          deadline: requestBody.Deadline
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task group setup
      effect: destructive
      questions:
      - How do I delete a task group setup?
      - Can I remove a task group setup record from the account?
      instructions:
      - text: Delete task group setup {id}.
        slots:
          id: path.id
      - text: Remove the task group setup {id} from the account.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a task group setup
      effect: read
      questions:
      - What comments have been left on a task group setup?
      - Can I see the comment history for a task group setup?
      instructions:
      - text: List comments on task group setup {id}.
        slots:
          id: path.id
      - text: Show the comment history for task group setup {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a task group setup
      effect: write
      questions:
      - How do I add a comment to a task group setup?
      - Can I annotate a task group setup with a note?
      instructions:
      - text: Add comment {comment} to task group setup {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment on task group setup {id} saying {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a task group setup
      effect: destructive
      questions:
      - How do I remove a comment from a task group setup?
      - Can I delete one comment on a task group setup?
      instructions:
      - text: Delete comment {commentId} from task group setup {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove comment {commentId} on task group setup {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history for a task group setup
      effect: read
      questions:
      - What changes have been made to a task group setup over time?
      - Can I see the edit history of a task group setup?
      instructions:
      - text: Show the change history of task group setup {id}.
        slots:
          id: path.id
      - text: List every edit made to task group setup {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskGroupSetup/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: See a task group setup as it was at a past time
      effect: read
      questions:
      - How do I view a task group setup as it existed at a past date?
      - Can I travel back to a task group setup's state at a specific timestamp?
      instructions:
      - text: Show task group setup {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to task group setup {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.
All 92 tools →

Call it yourself

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