Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Session API

11 actions 11 updates phrasing extends openapi/deputy-session-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/Session'].get
$.paths['/resource/Session/INFO'].get
$.paths['/resource/Session/PREDICT'].post
$.paths['/resource/Session/QUERY'].post
$.paths['/resource/Session/{id}'].get
$.paths['/resource/Session/{id}/COMMENTS'].get
$.paths['/resource/Session/{id}/COMMENTS'].post
$.paths['/resource/Session/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Session/{id}/HISTORY'].get
$.paths['/resource/Session/{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 Session API
  version: 1.0.0
extends: openapi/deputy-session-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/Session'].get
  update:
    x-apievangelist-phrasing:
      intent: List login sessions
      effect: read
      questions:
      - Which user sessions have been recorded in Deputy?
      - Can I page through all login sessions?
      instructions:
      - text: List all login sessions.
      - text: Show every session record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Session/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get session field metadata
      effect: read
      questions:
      - What fields and types does a session record have?
      - Which session fields can I query?
      instructions:
      - text: Show the field metadata for session records.
      - text: Describe the session resource schema.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Session/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing session by partial data
      effect: read
      questions:
      - Can I find an existing login session from a user id and IP?
      - Which session record matches a partial payload?
      instructions:
      - text: Find the existing session for user {UserId} from IP {Ip}.
        slots:
          UserId: requestBody.UserId
          Ip: requestBody.Ip
      - text: Match a session starting {Start} for user {UserId}.
        slots:
          Start: requestBody.Start
          UserId: requestBody.UserId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Session/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search login sessions
      effect: read
      questions:
      - Can I find sessions by user id or IP?
      - How do I sort and page session search results?
      instructions:
      - text: Search sessions matching {search}.
        slots:
          search: requestBody.search
      - text: Find sessions sorted by {sort}, {max} per page.
        slots:
          sort: requestBody.sort
          max: requestBody.max
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Session/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a login session
      effect: read
      questions:
      - What are the details of one login session?
      - Can I fetch a session by its id?
      instructions:
      - text: Get session {id}.
        slots:
          id: path.id
      - text: Show login session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Session/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a session
      effect: read
      questions:
      - What comments have been left on a login session?
      - Can I read the comment history of a session?
      instructions:
      - text: List comments on session {id}.
        slots:
          id: path.id
      - text: Show the comment history of session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Session/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a session
      effect: write
      questions:
      - Can I add a comment to a login session?
      - How do I annotate a session with a note?
      instructions:
      - text: Comment {Comment} on session {id}.
        slots:
          Comment: requestBody.Comment
          id: path.id
      - text: 'Add a note to session {id}: {Comment}.'
        slots:
          id: path.id
          Comment: requestBody.Comment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Session/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a session
      effect: destructive
      questions:
      - Can I remove a comment from a login session?
      - How do I delete a session comment?
      instructions:
      - text: Delete comment {commentId} from session {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove session {id}'s comment {commentId}.
        slots:
          id: path.id
          commentId: path.commentId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Session/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a session's change history
      effect: read
      questions:
      - What changes have been made to a login session?
      - Can I see the edit history of a session?
      instructions:
      - text: Show the change history of session {id}.
        slots:
          id: path.id
      - text: List edits made to session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Session/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a session as it was at a past time
      effect: read
      questions:
      - Can I see a login session as it looked at a specific moment?
      - What did a session record contain at a past timestamp?
      instructions:
      - text: Show session {id} as it existed at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Revert session {id} to its state 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-session-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.