Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Task Setup API

17 actions 17 updates phrasing extends openapi/deputy-tasksetup-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/TaskSetup'].get
$.paths['/resource/TaskSetup'].put
$.paths['/resource/TaskSetup'].post
$.paths['/resource/TaskSetup/BULK'].post
$.paths['/resource/TaskSetup/INFO'].get
$.paths['/resource/TaskSetup/PREDICT'].post
$.paths['/resource/TaskSetup/QUERY'].post
$.paths['/resource/TaskSetup/{id}'].get
$.paths['/resource/TaskSetup/{id}'].put
$.paths['/resource/TaskSetup/{id}'].post
$.paths['/resource/TaskSetup/{id}'].delete
$.paths['/resource/TaskSetup/{id}/COMMENTS'].get
$.paths['/resource/TaskSetup/{id}/COMMENTS'].post
$.paths['/resource/TaskSetup/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/TaskSetup/{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 Setup API
  version: 1.0.0
extends: openapi/deputy-tasksetup-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/TaskSetup'].get
  update:
    x-apievangelist-phrasing:
      intent: List task setup records
      effect: read
      questions:
      - What task setup records do I have access to?
      - Can I page through all task setup records?
      instructions:
      - text: List my task setup records.
      - text: Show every task setup record I can see.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a task setup record
      effect: write
      questions:
      - How do I create a task setup record with a given question and yes/no actions?
      - Can I replace a task setup record by its id?
      instructions:
      - text: Create task setup {id} in group {groupId} with question {question}, yes {onYes}, no {onNo}, render {renderFunc}.
        slots:
          id: requestBody.Id
          groupId: requestBody.GroupId
          question: requestBody.Question
          onYes: requestBody.OnYes
          onNo: requestBody.OnNo
          renderFunc: requestBody.RenderFunc
      - text: Create task setup {id} for group {groupId} with question {question}, yes {onYes}, no {onNo}, render {renderFunc}, created {created}, modified {modified}, creator {creator}.
        slots:
          id: requestBody.Id
          groupId: requestBody.GroupId
          question: requestBody.Question
          onYes: requestBody.OnYes
          onNo: requestBody.OnNo
          renderFunc: requestBody.RenderFunc
          created: requestBody.Created
          modified: requestBody.Modified
          creator: requestBody.Creator
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task setup record
      effect: write
      questions:
      - How do I add a new task setup record to a group?
      - Can I create a task setup record with a default answer and priority?
      instructions:
      - text: Create a task setup record in group {groupId} with question {question}, yes {onYes}, no {onNo}, render {renderFunc}.
        slots:
          groupId: requestBody.GroupId
          question: requestBody.Question
          onYes: requestBody.OnYes
          onNo: requestBody.OnNo
          renderFunc: requestBody.RenderFunc
      - text: Add a task setup record to group {groupId} with question {question}, yes {onYes}, no {onNo}, render {renderFunc}, priority {priority}, default {default}.
        slots:
          groupId: requestBody.GroupId
          question: requestBody.Question
          onYes: requestBody.OnYes
          onNo: requestBody.OnNo
          renderFunc: requestBody.RenderFunc
          priority: requestBody.Priority
          default: requestBody.Default
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many task setup records
      effect: write
      questions:
      - Can I create or update several task setup records in one request?
      - How do I bulk upsert task setup records?
      instructions:
      - text: Bulk create or update these task setup records.
      - text: Upsert a batch of task setup records in one call.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get task setup field metadata
      effect: read
      questions:
      - Which fields and types exist on task setup records?
      - What associations does the task setup resource have?
      instructions:
      - text: Show the field metadata for task setup.
      - text: List the queryable fields and associations of task setup.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing task setup record
      effect: read
      questions:
      - Can I find an existing task setup record before creating a new one?
      - What matching task setup record already exists for a partial payload?
      instructions:
      - text: Predict-match a task setup record with question {question}, yes {onYes}, no {onNo}, render {renderFunc}.
        slots:
          question: requestBody.Question
          onYes: requestBody.OnYes
          onNo: requestBody.OnNo
          renderFunc: requestBody.RenderFunc
      - text: Find the existing task setup record matching question {question}, yes {onYes}, no {onNo}, render {renderFunc}.
        slots:
          question: requestBody.Question
          onYes: requestBody.OnYes
          onNo: requestBody.OnNo
          renderFunc: requestBody.RenderFunc
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search task setup records
      effect: read
      questions:
      - How do I search task setup records by question or group?
      - Can I sort task setup search results?
      instructions:
      - text: Search task setup records where {search}.
        slots:
          search: requestBody.search
      - text: Find task setup records matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task setup record
      effect: read
      questions:
      - What question and yes/no actions does a task setup record have?
      - Can I fetch one task setup record by id?
      instructions:
      - text: Get task setup {id}.
        slots:
          id: path.id
      - text: Show the question and actions of task setup {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a task setup record
      effect: write
      questions:
      - How do I overwrite a task setup record completely?
      - Can I replace a task setup record with a new schedule?
      instructions:
      - text: Replace task setup {id} in group {groupId} with question {question}, yes {onYes}, no {onNo}, render {renderFunc}.
        slots:
          id: path.id
          groupId: requestBody.GroupId
          question: requestBody.Question
          onYes: requestBody.OnYes
          onNo: requestBody.OnNo
          renderFunc: requestBody.RenderFunc
      - text: Overwrite task setup {id} with a new schedule {schedule}.
        slots:
          id: path.id
          schedule: requestBody.Schedule
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a task setup record
      effect: write
      questions:
      - Can I change the default answer on an existing task setup record?
      - How do I edit a task setup record's priority?
      instructions:
      - text: Update task setup {id} with question {question}, yes {onYes}, no {onNo}, render {renderFunc}.
        slots:
          id: path.id
          question: requestBody.Question
          onYes: requestBody.OnYes
          onNo: requestBody.OnNo
          renderFunc: requestBody.RenderFunc
      - text: Set the default answer on task setup {id} to {default}.
        slots:
          id: path.id
          default: requestBody.Default
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task setup record
      effect: destructive
      questions:
      - How do I delete a task setup record?
      - Can I remove a task setup record by id?
      instructions:
      - text: Delete task setup {id}.
        slots:
          id: path.id
      - text: Remove the task setup record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a task setup record
      effect: read
      questions:
      - What comments have been left on a task setup record?
      - Can I see the comment history of a task setup?
      instructions:
      - text: List comments on task setup {id}.
        slots:
          id: path.id
      - text: Show the comment history of task setup {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a task setup record
      effect: write
      questions:
      - How do I comment on a task setup record?
      - Can I add a comment to a task setup record by id?
      instructions:
      - text: Add comment {comment} to task setup {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment on task setup {id} saying {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a task setup record
      effect: destructive
      questions:
      - How do I remove a comment from a task setup record?
      - Can I delete a single comment on a task setup by id?
      instructions:
      - text: Delete comment {commentId} from task setup {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove comment {commentId} on task setup {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history of a task setup record
      effect: read
      questions:
      - What changes have been made to a task setup record?
      - Can I see the edit history of a task setup?
      instructions:
      - text: Show the change history of task setup {id}.
        slots:
          id: path.id
      - text: List every edit made to task setup {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/TaskSetup/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: See a task setup record as it was at a past time
      effect: read
      questions:
      - Can I view a task setup record as it existed at a past timestamp?
      - What did a task setup record look like before its last edit?
      instructions:
      - text: Show task setup {id} as it existed at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to task setup {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-tasksetup-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.