ZoomInfo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agent API V1 Interact [Experimental] API

4 actions 4 updates phrasing extends openapi/zoominfo-interact-experimental-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 4

$.info
$.paths['/agent/v1/agents'].get
$.paths['/agent/v1/agents/{agentId}/actions/interact'].post
$.paths['/agent/v1/agents/{agentId}/actions/stream'].post

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 Interact [Experimental] API
  version: 1.0.0
extends: openapi/zoominfo-interact-experimental-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: 3
- target: $.paths['/agent/v1/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List available AI agents
      effect: read
      questions:
      - Which AI agents can I interact with?
      - What agents are available in my account?
      instructions:
      - text: List the available agents.
      - text: Show me the agents I can talk to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent/v1/agents/{agentId}/actions/interact'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message to an agent
      effect: write
      questions:
      - How do I ask an agent a question and get the full reply at once?
      - Can I interact with an agent without streaming?
      instructions:
      - text: 'Ask agent {agentId}: {message}'
        slots:
          agentId: path.agentId
          message: requestBody.data
      - text: Send {message} to agent {agentId} and return the complete answer.
        slots:
          message: requestBody.data
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent/v1/agents/{agentId}/actions/stream'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream a response from an agent
      effect: write
      questions:
      - Can I stream an agent's reply as it's generated?
      - How do I get incremental output from an agent?
      instructions:
      - text: Stream agent {agentId}'s reply to {message}.
        slots:
          agentId: path.agentId
          message: requestBody.data
      - text: Send {message} to agent {agentId} as a streaming interaction.
        slots:
          message: requestBody.data
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'