ZoomInfo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agent API V1 Agent Teams API

6 actions 6 updates phrasing extends openapi/zoominfo-agent-teams-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ZoomInfo's API. It is a proposal applied on top of the contract, not a document ZoomInfo publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/agent/v1/agent-teams'].get
$.paths['/agent/v1/agent-teams/{agentTeamId}'].get
$.paths['/agent/v1/agent-teams/{agentTeamId}/runs'].get
$.paths['/agent/v1/agent-teams/{agentTeamId}/runs'].post
$.paths['/agent/v1/agent-teams/{agentTeamId}/runs/{runId}'].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 Agent API V1 Agent Teams API
  version: 1.0.0
extends: openapi/zoominfo-agent-teams-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/agent/v1/agent-teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent teams
      effect: read
      questions:
      - Which agent teams are set up in my ZoomInfo account?
      - Can I see which agent teams are active and what triggers they have?
      - How do I find an agent team by its name?
      instructions:
      - text: List all my agent teams.
      - text: Find agent teams named {name}.
        slots:
          name: query.filter[name]
      - text: List agent teams sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent/v1/agent-teams/{agentTeamId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent team's details and inputs
      effect: read
      questions:
      - What inputs does an agent team need before I can run it?
      - Can I see the full configuration of a single agent team?
      instructions:
      - text: Show the details of agent team {agentTeamId}.
        slots:
          agentTeamId: path.agentTeamId
      - text: Tell me which input parameters agent team {agentTeamId} requires.
        slots:
          agentTeamId: path.agentTeamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent/v1/agent-teams/{agentTeamId}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List past runs of an agent team
      effect: read
      questions:
      - What's the run history for one of my agent teams?
      - Can I see every time an agent team has been run, newest first?
      instructions:
      - text: List the runs of agent team {agentTeamId}.
        slots:
          agentTeamId: path.agentTeamId
      - text: Show page {page} of run history for agent team {agentTeamId}.
        slots:
          page: query.page[number]
          agentTeamId: path.agentTeamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent/v1/agent-teams/{agentTeamId}/runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an agent team run
      effect: write
      questions:
      - How do I kick off an agent team manually?
      - Can I run an agent team even if it's marked inactive?
      instructions:
      - text: Run agent team {agentTeamId} with inputs {inputs}.
        slots:
          agentTeamId: path.agentTeamId
          inputs: requestBody.data
      - text: Trigger a new run of agent team {agentTeamId} using {inputs}.
        slots:
          agentTeamId: path.agentTeamId
          inputs: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent/v1/agent-teams/{agentTeamId}/runs/{runId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an agent team run's status and output
      effect: read
      questions:
      - Has my agent team run finished yet, and what did it produce?
      - How do I poll for the results of an agent team run I started?
      instructions:
      - text: Get the status and output of run {runId} for agent team {agentTeamId}.
        slots:
          runId: path.runId
          agentTeamId: path.agentTeamId
      - text: Check whether run {runId} of agent team {agentTeamId} is complete.
        slots:
          runId: path.runId
          agentTeamId: path.agentTeamId
      method: generated
      generated: '2026-09-26'