Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Team API

17 actions 17 updates phrasing extends openapi/deputy-team-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/Team'].get
$.paths['/resource/Team'].put
$.paths['/resource/Team'].post
$.paths['/resource/Team/BULK'].post
$.paths['/resource/Team/INFO'].get
$.paths['/resource/Team/PREDICT'].post
$.paths['/resource/Team/QUERY'].post
$.paths['/resource/Team/{id}'].get
$.paths['/resource/Team/{id}'].put
$.paths['/resource/Team/{id}'].post
$.paths['/resource/Team/{id}'].delete
$.paths['/resource/Team/{id}/COMMENTS'].get
$.paths['/resource/Team/{id}/COMMENTS'].post
$.paths['/resource/Team/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Team/{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 Team API
  version: 1.0.0
extends: openapi/deputy-team-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/Team'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams
      effect: read
      questions:
      - Which teams can I see in Deputy?
      - Is there a large-table pagination option for teams?
      instructions:
      - text: List all teams.
      - text: Show every team record I am allowed to see.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a team with a PUT
      effect: write
      questions:
      - How do I create a team with a full PUT body?
      - Can I replace a team record in one PUT request?
      instructions:
      - text: Create team {id} led by {leader} named {name}.
        slots:
          id: requestBody.Id
          leader: requestBody.LeaderEmployee
          name: requestBody.Name
      - text: Create team {id} with leader {leader}, name {name}, modified {modified}.
        slots:
          id: requestBody.Id
          leader: requestBody.LeaderEmployee
          name: requestBody.Name
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a team with a POST
      effect: write
      questions:
      - Can I create a team with a POST request?
      - What fields are required to create a team?
      instructions:
      - text: Create a new team named {name} led by {leader}.
        slots:
          name: requestBody.Name
          leader: requestBody.LeaderEmployee
      - text: Add a team {name} with leader {leader} and modified {modified}.
        slots:
          name: requestBody.Name
          leader: requestBody.LeaderEmployee
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many teams at once
      effect: write
      questions:
      - Can I create or update several teams in one request?
      - How do I bulk upsert team records?
      instructions:
      - text: Bulk create or update these teams.
      - text: Upsert this batch of team records in one call.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get team field metadata
      effect: read
      questions:
      - Which fields and associations exist on the team resource?
      - What types do team fields have?
      instructions:
      - text: Get the field metadata for team.
      - text: Show which team fields are queryable.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing team by partial data
      effect: read
      questions:
      - How do I find an existing team before creating one?
      - Can I predict-match a team from just its leader and name?
      instructions:
      - text: Predict-match a team with leader {leader} named {name}.
        slots:
          leader: requestBody.LeaderEmployee
          name: requestBody.Name
      - text: Find the existing team record matching leader {leader}, name {name}, modified {modified}.
        slots:
          leader: requestBody.LeaderEmployee
          name: requestBody.Name
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search teams
      effect: read
      questions:
      - How do I find teams by name or leader?
      - Can I sort and page team search results?
      instructions:
      - text: Search teams matching {search}.
        slots:
          search: requestBody.search
      - text: Find teams matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team by id
      effect: read
      questions:
      - How do I look up one team by its id?
      - What leader and name does a team have?
      instructions:
      - text: Get team {id}.
        slots:
          id: path.id
      - text: Show the leader and name of team {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a team's full record
      effect: write
      questions:
      - How do I overwrite a team's whole record?
      - Can I fully replace a team with a PUT?
      instructions:
      - text: Replace team {id} with leader {leader}, name {name}.
        slots:
          id: path.id
          leader: requestBody.LeaderEmployee
          name: requestBody.Name
      - text: Overwrite team {id} with modified {modified}.
        slots:
          id: path.id
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a team's fields
      effect: write
      questions:
      - How do I change a team's leader or name?
      - Can I patch a team's fields without replacing it?
      instructions:
      - text: Update team {id} to leader {leader}, name {name}.
        slots:
          id: path.id
          leader: requestBody.LeaderEmployee
          name: requestBody.Name
      - text: Patch team {id} with modified {modified}.
        slots:
          id: path.id
          modified: requestBody.Modified
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a team
      effect: destructive
      questions:
      - How do I delete a team?
      - Can I remove a team record?
      instructions:
      - text: Delete team {id}.
        slots:
          id: path.id
      - text: Remove team {id} from the system.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a team
      effect: read
      questions:
      - What comments have been left on a team?
      - Can I read the comment history of a team?
      instructions:
      - text: List comments on team {id}.
        slots:
          id: path.id
      - text: Show the comment history of team {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a team
      effect: write
      questions:
      - How do I add a comment to a team?
      - Can I annotate a team record?
      instructions:
      - text: Add comment {comment} to team {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Comment team {id} with {comment}.
        slots:
          id: path.id
          comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a team
      effect: destructive
      questions:
      - How do I delete a comment from a team?
      - Can I remove a single team comment?
      instructions:
      - text: Delete comment {commentId} from team {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove team {id}'s comment {commentId}.
        slots:
          id: path.id
          commentId: path.commentId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team's change history
      effect: read
      questions:
      - What changes have been made to a team over time?
      - Can I see the edit history of a team?
      instructions:
      - text: Show the change history of team {id}.
        slots:
          id: path.id
      - text: List every edit made to team {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Team/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team as it was at a past time
      effect: read
      questions:
      - How do I see what a team looked like at a past moment?
      - Can I travel back to a team's state at a given timestamp?
      instructions:
      - text: Show team {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to team {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-team-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.