---
title: "Interact with Agent"
method: POST
path: "/agent/v1/agents/{agentId}/actions/interact"
tags: ["Interact [Experimental]"]
---

# Interact with Agent

`POST /agent/v1/agents/{agentId}/actions/interact`

## Request

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

Interact with Agent

## Path parameters

- `agentId` string, required

## Request body

- InteractRequestBody: Interact Request Body
  - `data` InteractRequest, required: Interact Request Body
    - `type` string, required: The type of the resource
    - `attributes` InteractRequestModel, required: InteractRequestModel
      - `threadId` string: Thread Id
      - `usersId` string: Users Id
      - `structuredContent` StructuredContent: StructuredContent
        - `agentProps` AgentProps: Agent Properties
        - `triggerActions` TriggerActions[]: Trigger Actions
          - `id` string, required: Id
          - `arguments` ActionArguments: Action Arguments
        - `agentState` AgentState: Agent State
      - `sections` ThreadMessageSections[]: Sections
        - `id` string: Id
        - `createdAt` string, date-time: Created At
        - `updatedAt` string, date-time: Updated At
        - `deletedAt` string, date-time: Deleted At
        - `additionalFields` AdditionalFields: Additional Fields
        - `threadMessageId` string, uuid, required: Thread Message Id
        - `sectionName` string, required: Section Name
        - `contentType` string, required: Content Type
        - `content` string, required: Content
        - `structuredContent` StructuredContentObject, required: Structured Content Object
        - `renderProps` RenderProps, required: Render Properties
        - `meta` MetaInfo, required: Meta Information
        - `state` string, required: State
        - `userFacing` boolean, required: User Facing
        - `controls` ThreadMessageSectionControl[]: Controls
          - `id` string: Id
          - `createdAt` string, date-time: Created At
          - `updatedAt` string, date-time: Updated At
          - `deletedAt` string, date-time: Deleted At
          - `additionalFields` AdditionalFields: Additional Fields
          - `threadMessageSectionId` string, uuid, required: Thread Message Section Id
          - `name` string, required: Name
          - `type` string, required: Type
          - `props` ControlProps, required: Control Props
          - `value` ControlValue, required: Control Value
          - `inline` boolean, required: Inline
          - `entityType` string, required: Entity Type
          - `entityId` string, required: Entity Id
      - `userMessageId` string: User Message Id
      - `interactionId` string: Interaction Id
      - `relationships` Relationship[]: Relationships
        - `entityType` string, required: Entity Type
        - `entityId` string, required: Entity Id
      - `message` string, required: Message

## Response `200`

Success

- ThreadMessageResponse: ThreadMessageResponse
  - `data` Thread, required: Response Model
    - `id` string, required: The unique identifier for the resource
    - `type` string, required: The type of the resource
    - `attributes` ThreadMessages, required: ThreadMessages
      - `id` string: Id
      - `createdAt` string, date-time: Created At
      - `updatedAt` string, date-time: Updated At
      - `deletedAt` string, date-time: Deleted At
      - `additionalFields` AdditionalFields: Additional Fields
      - `threadId` string, uuid, required: Thread Id
      - `usersId` string, required: Users Id
      - `role` string, required: Role
      - `content` string, required: Content
      - `structuredContent` StructuredContent, required: StructuredContent
        - `agentProps` AgentProps: Agent Properties
        - `triggerActions` TriggerActions[]: Trigger Actions
          - `id` string, required: Id
          - `arguments` ActionArguments: Action Arguments
        - `agentState` AgentState: Agent State
      - `parentThreadMessageId` string, required: Parent Thread Message Id
      - `state` string, required: State
      - `sections` ThreadMessageSections[]: Sections
        - `id` string: Id
        - `createdAt` string, date-time: Created At
        - `updatedAt` string, date-time: Updated At
        - `deletedAt` string, date-time: Deleted At
        - `additionalFields` AdditionalFields: Additional Fields
        - `threadMessageId` string, uuid, required: Thread Message Id
        - `sectionName` string, required: Section Name
        - `contentType` string, required: Content Type
        - `content` string, required: Content
        - `structuredContent` StructuredContentObject, required: Structured Content Object
        - `renderProps` RenderProps, required: Render Properties
        - `meta` MetaInfo, required: Meta Information
        - `state` string, required: State
        - `userFacing` boolean, required: User Facing
        - `controls` ThreadMessageSectionControl[]: Controls
          - `id` string: Id
          - `createdAt` string, date-time: Created At
          - `updatedAt` string, date-time: Updated At
          - `deletedAt` string, date-time: Deleted At
          - `additionalFields` AdditionalFields: Additional Fields
          - `threadMessageSectionId` string, uuid, required: Thread Message Section Id
          - `name` string, required: Name
          - `type` string, required: Type
          - `props` ControlProps, required: Control Props
          - `value` ControlValue, required: Control Value
          - `inline` boolean, required: Inline
          - `entityType` string, required: Entity Type
          - `entityId` string, required: Entity Id

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests

---

[API](https://skmtc.dev/zoominfo/apis/agent-api-v1.md) - [All operations](https://skmtc.dev/zoominfo/apis/agent-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/zoominfo/apis/agent-api-v1/revisions/01784a5ae274?raw)