ZOzoominfo
Agents

Get Agent Run

Retrieves the current status and results of a specific agent run. Use the run id returned in data.id by Start Agent Run or the first event of a streaming run by Start Agent Run (Stream).

By default, the endpoint returns the run's current state immediately. Set returnImmediately=false to wait for the run to reach a terminal state. Requests that remain open can wait for up to 300 seconds. If the request times out before the run completes, the response returns the in-progress run and execution continues in the background. Call this endpoint again with the same run id to retrieve the latest status and results.

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.

For agents that support streaming, use Resume Agent Run Stream to follow the run in real time.

get/agent/v1/agents/{agentId}/runs/{runId}

Request

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

Path parameters

agentIdstring required

The unique identifier of the agent.

runIdstring required

The unique identifier of the run.

Query parameters

returnImmediatelyboolean

When false, wait for the run to reach a terminal state, up to 300 seconds. Default true: return the current snapshot without blocking.

Response

Success

Changes

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