Agents

Start Agent Run

Starts a new run for the specified agent.

By default, agent runs are asynchronous. The request returns the in-progress run, including its run id in data.id, while execution continues in the background. Use that run id with Get Agent Run to retrieve the latest status and final result.

To run the agent synchronously, set returnImmediately: false in data.attributes. The connection remains open while the agent executes, up to a maximum of 300 seconds. If the run does not complete within that window, the response returns the in-progress run and execution continues in the background. Use the returned run id from data.id with Get Agent Run to retrieve the latest status and final result.

When the run completes, the first item in artifacts contains the primary response and may include text and structured data. Additional artifacts, when present, contain supplementary output.

The request message is validated against the agent's inputSchema. Use Get Agent Details before starting a run to review the required input format.

post/agent/v1/agents/{agentId}/runs

Request

  • Base URL
    https://api.zoominfo.com/gtm
  • URL
    https://api.zoominfo.com/gtm/agent/v1/agents/{agentId}/runs
  • Auth
    OAuth 2
    Authorization code: https://login.zoominfo.com
    Token URL: https://okta-login.zoominfo.com/oauth2/default/v1/token scopes: api:agent:execute

Path parameters

agentIdstring required

The unique identifier of the agent to run.

Request body

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.