{"openapi":"3.0.0","info":{"title":"Agent API V1","version":"1.0","contact":{"name":"ZoomInfo Customer Support","email":"help@zoominfo.com"},"description":"This definition only exposes one of many API routes from agentic-ai-platform\n    in order to quickly support an integration opportunity with SalesForce.\n    The model includes some definitions used by API routes that are not being\n    surfaced at this time. They remain included where they are referenced as\n    dependencies, to avoid model refactoring, and with the intent that additional\n    capabilities of agentic-ai-platform will be released under ZI-API in the future/"},"tags":[{"name":"Interact [Experimental]"},{"name":"Agent Teams"},{"name":"Pulses"}],"paths":{"/agent/v1/agents":{"get":{"operationId":"AgentInterace_listAgents","summary":"List agents","description":"List available agents","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AgentListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Interact [Experimental]"],"security":[{"OAuth2Auth":["api:agent:agentforce"]}],"x-api-roles":["fea:afa"]}},"/agent/v1/agents/{agentId}/actions/interact":{"post":{"operationId":"AgentInterace_interactAgent","summary":"Interact with Agent","description":"Interact with Agent","parameters":[{"name":"agentId","in":"path","required":true,"description":"The agent to interact with","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ThreadMessageResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Interact [Experimental]"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/InteractRequestBody"}}},"description":"The POST body"},"security":[{"OAuth2Auth":["api:agent:agentforce"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:afa"]}},"/agent/v1/agents/{agentId}/actions/stream":{"post":{"operationId":"AgentInterace_interactAgentStream","summary":"Interact with Agent (Stream)","description":"Interact with Agent (Stream)","parameters":[{"name":"agentId","in":"path","required":true,"description":"The agent to interact with","schema":{"type":"string"}}],"responses":{"200":{"description":"The request has succeeded.","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/SseResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Interact [Experimental]"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/InteractRequestBody"}}},"description":"The POST body"},"security":[{"OAuth2Auth":["api:agent:agentforce"]}],"x-additional-content-types":["application/json"],"x-is-sse":true,"x-api-roles":["fea:afa"]}},"/agent/v1/agent-teams":{"get":{"operationId":"AgentTeamsController_listAgentTeams","summary":"List Agent Teams","description":"Returns a list of Agent Teams. Each Agent Team contains information about the Agent Team including its name, \nthe registered triggers that can initiate an Agent Team run, and whether the Agent Team and its triggers are\ncurrently active.\n\nAgent Teams can be run using [Run Agent Team](ref:agentteamscontroller_runagentteam). Any Agent Team can\nbe executed manually using that endpoint, regardless of whether the Agent Team is marked as active or inactive.\nTo get additional details for an Agent Team, including the required inputs needed to create a new run, please use\n[Get Agent Team Details](ref:agentteamscontroller_getagentteamdetails)","parameters":[{"name":"page[size]","in":"query","required":false,"description":"The number of Agent Teams to return per page of results. Allowable values are between 1 and 100.\nThe default value if not provided is 25 Agent Teams per page.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"page[number]","in":"query","required":false,"description":"The page of results you would like to fetch. The default value if not provided is `1` to fetch the first page of results ","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"sort","in":"query","required":false,"description":"Sort results by the specified output field. Valid values are name, createdAt, and updatedAt. \nAdd minus sign ('-') before the sort field name for descending order. The default sort if not\nprovided is `name` (sorted by name in alphabetical order)","schema":{"type":"string"},"explode":false},{"name":"filter[name]","in":"query","required":false,"description":"Filter Agent Teams by name.","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AgentTeamsListResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Agent Teams"],"security":[{"OAuth2Auth":["api:agent-teams:read"]}],"x-api-roles":["fea:pls"]}},"/agent/v1/agent-teams/{agentTeamId}":{"get":{"operationId":"AgentTeamsController_getAgentTeamDetails","summary":"Get Agent Team Details","description":"Fetch an Agent Team by id, returning the full Agent Team details. The Agent Team details include configured input\nparameters that are required when executing an Agent Team using the [Run Agent Team](ref:agentteamscontroller_runagentteam) endpoint.\n\nUse [List Agent Teams](ref:agentteamscontroller_listagentteams) to find an Agent Team if you don't already know the identifier\nyou are looking to get details for.","parameters":[{"name":"agentTeamId","in":"path","required":true,"description":"The unique identifier of the Agent Team","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AgentTeamDetailResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Agent Teams"],"security":[{"OAuth2Auth":["api:agent-teams:read"]}],"x-api-roles":["fea:pls"]}},"/agent/v1/agent-teams/{agentTeamId}/runs":{"post":{"operationId":"AgentTeamsController_runAgentTeam","summary":"Run Agent Team","description":"Triggers an Agent Team run. Any Agent Team can be run manually using this endpoint, even if the\nAgent Team is marked with inactive.\n\nAgent Teams run asynchronously, so this endpoint returns the Agent Team run with the id created \nand the initial run status. Poll [Get Agent Team Results](ref:agentteamscontroller_getagentteamrun)\nto get status updates on the Agent Team run.","parameters":[{"name":"agentTeamId","in":"path","required":true,"description":"The unique identifier of the Agent Team to run.","schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AgentTeamRunResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Agent Teams"],"requestBody":{"required":false,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/RunAgentTeamRequestBody"}}},"description":"Request body containing optional named inputs for the Agent Team run."},"security":[{"OAuth2Auth":["api:agent-teams:execute"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:pls"]},"get":{"operationId":"AgentTeamsController_listAgentTeamRuns","summary":"List Agent Team Runs","description":"Fetch all runs for an Agent Team.\n\nDo not use this endpoint to poll for the status of an Agent Team run, for that please use\n[Get Agent Team Results](ref:agentteamscontroller_getagentteamrun). The list of Agent Team runs\nwill always return sorted in reverse chronological order.","parameters":[{"name":"agentTeamId","in":"path","required":true,"description":"The unique identifier of the Agent Team","schema":{"type":"string"}},{"name":"page[size]","in":"query","required":false,"description":"The number of Agent Team runs to return per page of results. Allowable values are between 1 and 100.\nThe default value if not provided is 25 Agent Team runs per page.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"page[number]","in":"query","required":false,"description":"The page of results you would like to fetch. The default value if not provided is `1` to fetch the first page of results.","schema":{"type":"integer","format":"int32","minimum":1},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AgentTeamRunsListResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Agent Teams"],"security":[{"OAuth2Auth":["api:agent-teams:read"]}],"x-api-roles":["fea:pls"]}},"/agent/v1/agent-teams/{agentTeamId}/runs/{runId}":{"get":{"operationId":"AgentTeamsController_getAgentTeamRun","summary":"Get Agent Team Results","description":"Retrieves the current status and available output for a previously started Agent Team run.\n\nPoll this endpoint after executing an Agent Team run to check the status of that Agent Team.\nReturns `404` when the Agent Team or run does not exist, or if the run does not belong to the\nspecified Agent Team.","parameters":[{"name":"agentTeamId","in":"path","required":true,"description":"The unique identifier of the Agent Team associated with the run.","schema":{"type":"string"}},{"name":"runId","in":"path","required":true,"description":"The unique identifier of the Agent Team run.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AgentTeamRunResponse"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Agent Teams"],"security":[{"OAuth2Auth":["api:agent-teams:read"]}],"x-api-roles":["fea:pls"]}},"/agent/v1/pulses":{"get":{"operationId":"PulsesController_listPulses","summary":"List Pulses","description":"Returns the authenticated user's active pulses as a lightweight collection optimized for consumption\nby large language models (LLMs). Each entry includes a plain-text summary of the rendered content,\npriority, category, typed identity references for associated companies and contacts, and an optional\n`context` explanation.\n\nDesigned for AI / agent consumption. Dismissed, saved, and expired pulses are excluded.\n\n\n## Ordering\nResults are returned in stable descending order of `meta.createdAt`, then by `priority`\n(`HIGH` first, then `MEDIUM`, then `LOW`), then by `id` ascending as a tiebreaker. The ordering\nis consistent across pages so pagination is safe under concurrent inserts.\n","parameters":[{"name":"page[size]","in":"query","required":false,"description":"The number of pulses to return per page of results. Allowable values are between 1 and 100.\nThe default value if not provided is 25 pulses per page.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"page[number]","in":"query","required":false,"description":"The page of results to fetch. The default value if not provided is `1` to fetch the first page of results.","schema":{"type":"integer","format":"int32","minimum":1},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/PulsesListResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Pulses"],"security":[{"OAuth2Auth":["api:agent-pulses:read"]}],"x-api-roles":["fea:pls"]}}},"security":[{"OAuth2Auth":[]}],"components":{"schemas":{"AgentListItem":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Agent identifier"}},"description":"Agent List Item"},"AgentList":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"agent","pattern":"agent"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AgentListItem"}],"description":"The attributes defining the resource"}},"description":"Agent List Resource"},"AgentListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgentList"},"description":"The primary data of the document"}},"description":"Agent List Response"},"ZoomInfo.Core.Foundations.ErrorSourceModel":{"type":"object","properties":{"cookie":{"type":"string","description":"Identifies the cookie name that caused the issue"},"header":{"type":"string","description":"Identifies the header name that caused the error"},"pointer":{"type":"string","description":"An RFC 6901 compliant JSON pointer to the entity in the request body that caused the error"},"parameter":{"type":"string","description":"The name of the path or query parameter that caused the error"}}},"ZoomInfo.Core.Foundations.ErrorModel":{"type":"object","required":["id","code","status"],"properties":{"id":{"type":"string","description":"The unique id used to identify this specific error instance"},"code":{"type":"string","description":"The error code describing the error category. A full list of error codes can be found in the documentation for each service"},"detail":{"type":"string","description":"Message containing the specific details about this occurrence of the error"},"source":{"allOf":[{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorSourceModel"}],"description":"An optional object identifying which part of the request caused the error"},"status":{"type":"string","description":"The HTTP status code for the error"},"title":{"type":"string","description":"The error name that describes this type of error"}},"description":"The object describing a specific error from the API"},"ZoomInfo.Core.Foundations.ErrorResponseModel":{"type":"object","required":["errors"],"properties":{"detail":{"type":"string","description":"A high-level detail of the error(s) that occurred during the request"},"title":{"type":"string","description":"A high-level summary of the error(s) detected"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorModel"},"description":"The list of errors raised during the request"}},"description":"The standard error response body model for the ZoomInfo API."},"AdditionalFields":{"type":"object","description":"Additional Fields"},"AgentProps":{"type":"object","description":"Agent Properties"},"ActionArguments":{"type":"object","description":"Action Arguments"},"TriggerActions":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id"},"arguments":{"allOf":[{"$ref":"#/components/schemas/ActionArguments"}],"description":"Arguments"}},"description":"TriggerActions"},"AgentState":{"type":"object","description":"Agent State"},"StructuredContent":{"type":"object","properties":{"agentProps":{"allOf":[{"$ref":"#/components/schemas/AgentProps"}],"description":"Agent Props"},"triggerActions":{"type":"array","items":{"$ref":"#/components/schemas/TriggerActions"},"description":"Trigger Actions"},"agentState":{"allOf":[{"$ref":"#/components/schemas/AgentState"}],"description":"Agent State"}},"description":"StructuredContent"},"StructuredContentObject":{"type":"object","description":"Structured Content Object"},"RenderProps":{"type":"object","description":"Render Properties"},"MetaInfo":{"type":"object","description":"Meta Information"},"ControlProps":{"type":"object","description":"Control Props"},"ControlValue":{"type":"object","description":"Control Value"},"ThreadMessageSectionControl":{"type":"object","required":["threadMessageSectionId","name","type","props","value","inline","entityType","entityId"],"properties":{"id":{"type":"string","description":"Id"},"createdAt":{"type":"string","format":"date-time","description":"Created At"},"updatedAt":{"type":"string","format":"date-time","description":"Updated At"},"deletedAt":{"type":"string","format":"date-time","description":"Deleted At"},"additionalFields":{"allOf":[{"$ref":"#/components/schemas/AdditionalFields"}],"description":"Additional Fields"},"threadMessageSectionId":{"type":"string","format":"uuid","description":"Thread Message Section Id"},"name":{"type":"string","description":"Name"},"type":{"type":"string","description":"Type"},"props":{"allOf":[{"$ref":"#/components/schemas/ControlProps"}],"description":"Props"},"value":{"allOf":[{"$ref":"#/components/schemas/ControlValue"}],"description":"Value"},"inline":{"type":"boolean","description":"Inline"},"entityType":{"type":"string","description":"Entity Type"},"entityId":{"type":"string","description":"Entity Id"}},"description":"ThreadMessageSectionControl"},"ThreadMessageSections":{"type":"object","required":["threadMessageId","sectionName","contentType","content","structuredContent","renderProps","meta","state","userFacing"],"properties":{"id":{"type":"string","description":"Id"},"createdAt":{"type":"string","format":"date-time","description":"Created At"},"updatedAt":{"type":"string","format":"date-time","description":"Updated At"},"deletedAt":{"type":"string","format":"date-time","description":"Deleted At"},"additionalFields":{"allOf":[{"$ref":"#/components/schemas/AdditionalFields"}],"description":"Additional Fields"},"threadMessageId":{"type":"string","format":"uuid","description":"Thread Message Id"},"sectionName":{"type":"string","description":"Section Name"},"contentType":{"type":"string","description":"Content Type"},"content":{"type":"string","description":"Content"},"structuredContent":{"allOf":[{"$ref":"#/components/schemas/StructuredContentObject"}],"description":"Structured Content"},"renderProps":{"allOf":[{"$ref":"#/components/schemas/RenderProps"}],"description":"Render Props"},"meta":{"allOf":[{"$ref":"#/components/schemas/MetaInfo"}],"description":"Meta"},"state":{"type":"string","description":"State"},"userFacing":{"type":"boolean","description":"User Facing"},"controls":{"type":"array","items":{"$ref":"#/components/schemas/ThreadMessageSectionControl"},"description":"Controls","default":[]}},"description":"ThreadMessageSections"},"ThreadMessages":{"type":"object","required":["threadId","usersId","role","content","structuredContent","parentThreadMessageId","state"],"properties":{"id":{"type":"string","description":"Id"},"createdAt":{"type":"string","format":"date-time","description":"Created At"},"updatedAt":{"type":"string","format":"date-time","description":"Updated At"},"deletedAt":{"type":"string","format":"date-time","description":"Deleted At"},"additionalFields":{"allOf":[{"$ref":"#/components/schemas/AdditionalFields"}],"description":"Additional Fields"},"threadId":{"type":"string","format":"uuid","description":"Thread Id"},"usersId":{"type":"string","description":"Users Id"},"role":{"type":"string","description":"Role"},"content":{"type":"string","description":"Content"},"structuredContent":{"allOf":[{"$ref":"#/components/schemas/StructuredContent"}],"description":"Structured Content"},"parentThreadMessageId":{"type":"string","description":"Parent Thread Message Id"},"state":{"type":"string","description":"State"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/ThreadMessageSections"},"description":"Sections"}},"description":"ThreadMessages"},"Thread":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Thread","pattern":"Thread"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ThreadMessages"}],"description":"The attributes defining the resource"}},"description":"Response Model"},"ThreadMessageResponse":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/Thread"}],"description":"The primary data of the document"}},"description":"ThreadMessageResponse"},"Relationship":{"type":"object","required":["entityType","entityId"],"properties":{"entityType":{"type":"string","description":"Entity Type"},"entityId":{"type":"string","description":"Entity Id"}},"description":"Relationship"},"InteractRequestModel":{"type":"object","required":["message"],"properties":{"threadId":{"type":"string","description":"Thread Id"},"usersId":{"type":"string","description":"Users Id"},"structuredContent":{"allOf":[{"$ref":"#/components/schemas/StructuredContent"}],"description":"StructuredContent"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/ThreadMessageSections"},"description":"Sections"},"userMessageId":{"type":"string","description":"User Message Id"},"interactionId":{"type":"string","description":"Interaction Id"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/Relationship"},"description":"Relationships"},"message":{"type":"string","description":"Message"}},"description":"InteractRequestModel"},"InteractRequest":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"InteractRequest","pattern":"InteractRequest"},"attributes":{"allOf":[{"$ref":"#/components/schemas/InteractRequestModel"}],"description":"The attributes defining the resource"}},"description":"Interact Request Body"},"InteractRequestBody":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/InteractRequest"}],"description":"The primary data of the document"}},"description":"Interact Request Body"},"SseResponseBody":{"type":"object","required":["data"],"properties":{"data":{"type":"string","description":"Server-sent events stream content"}},"description":"SSE Response Body"},"AgentTeamTriggerType":{"type":"string","enum":["MANUAL","ACCOUNT_CHANGE","WEBSITE_VISIT","EMAIL_RECEIVED","MEETING","WEBHOOK","CONTACT_CHANGE","OPPORTUNITY_CHANGE","SCHEDULE"]},"AgentTeamAttributes":{"type":"object","required":["name","triggers","active"],"properties":{"name":{"type":"string","description":"Name of the Agent Team."},"description":{"type":"string","description":"Human-readable description of the Agent Team. This field is omitted when no objective or description is defined."},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/AgentTeamTriggerType"},"description":"The trigger types associated with this Agent Team"},"active":{"type":"boolean","description":"Flag indicating whether the Agent Team's triggers are active or not. Agent Teams that are inactive can still be triggered manually"}},"description":"Public Agent Team details."},"AgentTeamMeta":{"type":"object","required":["createdAt","createdBy","updatedAt","creditsUsed"],"properties":{"createdAt":{"type":"string","format":"date-time","description":"The timestamp when this Agent Team was created"},"createdBy":{"type":"integer","format":"int32","description":"The id of the user that created this Agent Team"},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp for the last time this Agent Team was updated"},"creditsUsed":{"type":"integer","format":"int32","description":"The total amount of AI Credits consumed by this Agent Team over its lifespan"},"lastRunDate":{"type":"string","format":"date-time","description":"The date of the last successful run of this Agent Team"}},"description":"Metadata information for an Agent Team"},"AgentTeam":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"AgentTeam","pattern":"AgentTeam"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AgentTeamAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/AgentTeamMeta"}],"description":"Non-standard meta information about the resource"}},"description":"Agent Team resource."},"PagingMeta":{"type":"object","required":["page","pageSize","totalCount"],"properties":{"page":{"type":"integer","format":"uint32","description":"The current page of results being returned."},"pageSize":{"type":"integer","format":"uint32","description":"The page size as specified by the request."},"totalCount":{"type":"integer","format":"uint32","description":"The total count of results within the current search parameters."}},"description":"Metadata for the current page of results."},"PagingLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri","description":"A link to the first page of data"},"last":{"type":"string","format":"uri","description":"A link to the last page of data"},"prev":{"type":"string","format":"uri","description":"A link to the previous page of data"},"next":{"type":"string","format":"uri","description":"A link to the next page of data"}},"description":"Links describing the available paging options."},"AgentTeamsListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgentTeam"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/PagingMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/PagingLinks"}],"description":"Links related to the primary data"}},"description":"Response containing a list of Agent Teams."},"InputParameterType":{"type":"string","enum":["STRING"]},"InputParameter":{"type":"object","required":["name","required","type"],"properties":{"name":{"type":"string","description":"The name of the input parameter. This will be provided in the `name` attribute for the `RunAgentTeamRequest`"},"required":{"type":"boolean","description":"Indicates whether the parameter is required to start the Agent Team run"},"type":{"allOf":[{"$ref":"#/components/schemas/InputParameterType"}],"description":"The data type of the input parameter. Currently only STRING type parameters are supported"}},"description":"Describes an input parameter that is used to start an agent team run"},"AgentTeamDetailAttributes":{"type":"object","required":["name","triggers","active"],"properties":{"name":{"type":"string","description":"Name of the Agent Team."},"description":{"type":"string","description":"Human-readable description of the Agent Team. This field is omitted when no objective or description is defined."},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/AgentTeamTriggerType"},"description":"The trigger types associated with this Agent Team"},"active":{"type":"boolean","description":"Flag indicating whether the Agent Team's triggers are active or not. Agent Teams that are inactive can still be triggered manually"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/InputParameter"},"description":"The input parameters defined for this Agent Team. "}},"description":"Public Agent Team details."},"AgentTeamDetail":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"AgentTeam","pattern":"AgentTeam"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AgentTeamDetailAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/AgentTeamMeta"}],"description":"Non-standard meta information about the resource"}},"description":"Agent Team resource with full input parameter details."},"AgentTeamDetailResponse":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AgentTeamDetail"}],"description":"The primary data of the document"}},"description":"Response for a single Agent Team with input parameter details"},"AgentTeamRunStatus":{"type":"string","enum":["QUEUED","RUNNING","COMPLETED","FAILED","CANCELLED","STOPPING"],"description":"Lifecycle states for an Agent Team run.","x-enumDescriptions":{"QUEUED":"The Agent Team run is queued and waiting to start.","RUNNING":"The Agent Team run is currently executing.","COMPLETED":"The Agent Team run completed successfully.","FAILED":"The Agent Team run completed with a failure.","CANCELLED":"The Agent Team run was stopped before completion.","STOPPING":"The Agent Team run is currently in the process of shutting down"}},"AgentTeamInput":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"Name of the Agent Team input."},"value":{"type":"string","description":"Value supplied for the input."}},"description":"Input parameter passed to an Agent Team run."},"AgentTeamRunAttributes":{"type":"object","required":["agentTeamId","status"],"properties":{"agentTeamId":{"type":"string","description":"The unique identifier of the Agent Team associated with this run."},"status":{"allOf":[{"$ref":"#/components/schemas/AgentTeamRunStatus"}],"description":"Current execution status of the Agent Team run."},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/AgentTeamInput"},"description":"The inputs provided for this run of the Agent Team"},"output":{"type":"string","description":"Final or in-progress output for the Agent Team run. This field is omitted for runs that have not yet produced output."}},"description":"Attributes describing an Agent Team run"},"AgentTeamRunMeta":{"type":"object","required":["createdAt","createdBy","updatedAt"],"properties":{"createdAt":{"type":"string","format":"date-time","description":"The UTC date time when the Agent Team run was created"},"createdBy":{"type":"integer","format":"int32","description":"The id of the user that executed this Agent Team run"},"updatedAt":{"type":"string","format":"date-time","description":"The UTC date time when the Agent Team run was last updated"},"completedAt":{"type":"string","format":"date-time","description":"The UTC date time when the Agent Team run completed"},"totalCredits":{"type":"integer","format":"int32","description":"The total number of credits consumed by this Agent Team run. This value is only provided after the Agent Team has successfully finished executing"}},"description":"Metadata information for an Agent Team run"},"AgentTeamRun":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"AgentTeamRun","pattern":"AgentTeamRun"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AgentTeamRunAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/AgentTeamRunMeta"}],"description":"Non-standard meta information about the resource"}},"description":"Model describing an Agent Team run"},"AgentTeamRunResponse":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AgentTeamRun"}],"description":"The primary data of the document"}},"description":"Response containing a single Agent Team run."},"RunAgentTeamRequestAttributes":{"type":"object","properties":{"inputs":{"type":"array","items":{"$ref":"#/components/schemas/AgentTeamInput"},"description":"Optional list of named input values to pass to the Agent Team."}},"description":"Attributes for an Agent Team run request."},"RunAgentTeamRequest":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"RunAgentTeamRequest","pattern":"RunAgentTeamRequest"},"attributes":{"allOf":[{"$ref":"#/components/schemas/RunAgentTeamRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Agent Team run request resource."},"RunAgentTeamRequestBody":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/RunAgentTeamRequest"}],"description":"The primary data of the document"}},"description":"Request body for running an Agent Team."},"AgentTeamRunsListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgentTeamRun"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/PagingMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/PagingLinks"}],"description":"Links related to the primary data"}},"description":"Response containing a list of Agent Team runs."},"PulsePriority":{"type":"string","enum":["HIGH","MEDIUM","LOW"],"description":"Priority level of a pulse.","x-enumDescriptions":{"HIGH":"Highest urgency. Surface and act on these first.","MEDIUM":"Standard urgency.","LOW":"Lowest urgency. Informational; defer if higher-priority work is available."}},"PulseCategory":{"type":"string","enum":["FINANCIAL","PEOPLE","ACTIVITY","COMPETITIVE","INITIATIVE","ENGAGEMENT","PLAY","OTHER"],"description":"Top-level category a pulse belongs to.","x-enumDescriptions":{"FINANCIAL":"Funding, earnings, M&A, and budget-related signals.","PEOPLE":"Hires, departures, role changes, and leadership moves.","ACTIVITY":"Website activity, form intent signals, and engagement trends.","COMPETITIVE":"Competitor actions, market positioning, and win/loss signals.","INITIATIVE":"Strategic programs, transformations, and internal priorities.","ENGAGEMENT":"Meetings, calls, and other direct engagement themes.","PLAY":"Pulse originating from a GTM Studio play.","OTHER":"Uncategorized pulse."}},"PulseType":{"type":"string","enum":["INSIGHT","TASK","EVENT","SUMMARY"],"description":"Type of pulse content.","x-enumDescriptions":{"INSIGHT":"Insight or group of insights about a company or contact.","TASK":"Task assigned to a user.","EVENT":"Event such as an upcoming meeting.","SUMMARY":"Generic summary of data (for example, a weekly territory analysis or CRM hygiene digest)."}},"PulseSignalType":{"type":"string","enum":["CONTACT_NEW_HIRES","CONTACT_PROMOTIONS","CONTACT_DEPARTURES","UPCOMING_MEETING","WEBSITE_VISITOR","COMPETITOR_INTENT","WEBSITE_SPIKES","FORM_COMPLETE","WEBSITE_VISITS","COMPANY_FUNDING","HIRING","ANOMALOUS_HIRING","EARNINGS","INITIAL_PUBLIC_OFFERING","LAYOFFS","G2_TRUST_RADIUS","PODCAST_MENTIONS","PERSON_BASED_NEWS","BUYING_INTENT_SPIKE","TECHNOLOGY_ADDED"],"description":"Underlying signal that drove the pulse. New signal types are introduced by adding values to this enum; consumers should accept additive enum changes without treating them as a breaking schema change.","x-enumDescriptions":{"CONTACT_NEW_HIRES":"A contact at a target account has joined a new role.","CONTACT_PROMOTIONS":"A contact at a target account has been promoted.","CONTACT_DEPARTURES":"A contact at a target account has left the company.","UPCOMING_MEETING":"A meeting with a contact at a target account is upcoming.","WEBSITE_VISITOR":"A known contact visited the customer's website.","COMPETITOR_INTENT":"Intent activity indicating research into a competitor.","WEBSITE_SPIKES":"A spike in website traffic from a target account.","FORM_COMPLETE":"A contact at a target account completed a form on the customer's site.","WEBSITE_VISITS":"Website visits attributable to a target account (company-level).","COMPANY_FUNDING":"A target account raised a new round of funding.","HIRING":"A target account is hiring at a notable rate.","ANOMALOUS_HIRING":"A target account is hiring well outside its historical rate.","EARNINGS":"A target account published an earnings report or financial update.","INITIAL_PUBLIC_OFFERING":"A target account had an initial public offering.","LAYOFFS":"A target account announced layoffs.","G2_TRUST_RADIUS":"Activity on G2 or TrustRadius for the customer's product or competitors.","PODCAST_MENTIONS":"A target account or its contacts were mentioned on a podcast.","PERSON_BASED_NEWS":"News mentioning a specific contact at a target account.","BUYING_INTENT_SPIKE":"Account-level intent activity has spiked across buying topics.","TECHNOLOGY_ADDED":"A target account added a new technology to its stack."}},"PulseCompanyRef":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64","description":"ZoomInfo company identifier."},"name":{"type":"string","maxLength":256,"description":"Display name of the company."}},"description":"Identity of a company associated with a pulse. The `id` is a ZoomInfo company identifier and can be passed to other ZoomInfo APIs (for example the Data API enrichment endpoints)."},"PulseContactRef":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64","description":"ZoomInfo contact identifier."},"name":{"type":"string","maxLength":256,"description":"Display name of the contact."}},"description":"Identity of a contact associated with a pulse. The `id` is a ZoomInfo contact identifier and can be passed to other ZoomInfo APIs."},"PulseAttributes":{"type":"object","required":["title","priority","category","pulseType"],"properties":{"title":{"type":"string","maxLength":256,"description":"Display title of the pulse."},"priority":{"allOf":[{"$ref":"#/components/schemas/PulsePriority"}],"description":"Priority level assigned to the pulse."},"category":{"allOf":[{"$ref":"#/components/schemas/PulseCategory"}],"description":"Category the pulse belongs to."},"pulseType":{"allOf":[{"$ref":"#/components/schemas/PulseType"}],"description":"Type of pulse content."},"signalType":{"allOf":[{"$ref":"#/components/schemas/PulseSignalType"}],"description":"Underlying signal that drove the pulse. Present only on signal-derived pulses; absent on task, event, and summary pulses."},"companies":{"type":"array","items":{"$ref":"#/components/schemas/PulseCompanyRef"},"maxItems":100,"description":"Companies associated with the pulse. Each entry carries a ZoomInfo company identifier and display name so agents can chain into other ZoomInfo APIs without an additional lookup step. Absent when the pulse has no company associations (for example, a contact-only pulse)."},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/PulseContactRef"},"maxItems":100,"description":"Contacts associated with the pulse. Each entry carries a ZoomInfo contact identifier and display name so agents can chain into other ZoomInfo APIs without an additional lookup step. Absent when the pulse has no contact associations (for example, a company-only pulse)."},"summary":{"type":"string","maxLength":4000,"description":"Plain-text summary of the rendered pulse content. Suitable as input to a large language model (LLM). Absent when the content block fails to render or contains no extractable text."},"context":{"type":"string","maxLength":2000,"description":"LLM-generated natural-language context explaining why this pulse is relevant to the authenticated user. Non-deterministic: the wording, length, and emphasis can change across invocations and across underlying model versions. Treat the field as opaque context, not as a stable contract for downstream parsing."}},"description":"Lightweight view of a pulse optimized for consumption by large language models (LLMs). Omits content blocks, recipients, data sources, and calls to action (CTAs) in favor of typed identity references for associated companies and contacts plus an LLM-generated relevance explanation."},"PulseMeta":{"type":"object","required":["createdAt"],"properties":{"createdAt":{"type":"string","format":"date-time","description":"Time at which the pulse was created."},"expiresAt":{"type":"string","format":"date-time","description":"Time at which the pulse expires. Absent when the pulse has no expiration."}},"description":"System-managed metadata for a pulse."},"Pulse":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Pulse","pattern":"Pulse"},"attributes":{"allOf":[{"$ref":"#/components/schemas/PulseAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/PulseMeta"}],"description":"Non-standard meta information about the resource"}},"description":"A pulse delivered to the authenticated user."},"PulsesListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Pulse"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/PagingMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/PagingLinks"}],"description":"Links related to the primary data"}},"description":"Response containing a page of the authenticated user's active pulses."},"ThreadRelationships":{"type":"object","required":["entityId","entityType"],"properties":{"id":{"type":"string","description":"Id"},"createdAt":{"type":"string","format":"date-time","description":"Created At"},"updatedAt":{"type":"string","format":"date-time","description":"Updated At"},"deletedAt":{"type":"string","format":"date-time","description":"Deleted At"},"additionalFields":{"allOf":[{"$ref":"#/components/schemas/AdditionalFields"}],"description":"Additional Fields"},"threadId":{"type":"string","description":"Thread Id"},"usersId":{"type":"string","description":"Users Id"},"entityId":{"type":"string","description":"Entity Id"},"entityType":{"type":"string","description":"Entity Type"}},"description":"ThreadRelationships"},"ThreadStatus":{"type":"string","enum":["ACTIVE","INACTIVE"],"description":"ThreadStatus"},"Threads":{"type":"object","required":["name","usersId","currentThreadMessageId","status","messages"],"properties":{"id":{"type":"string","description":"Id"},"createdAt":{"type":"string","format":"date-time","description":"Created At"},"updatedAt":{"type":"string","format":"date-time","description":"Updated At"},"deletedAt":{"type":"string","format":"date-time","description":"Deleted At"},"additionalFields":{"allOf":[{"$ref":"#/components/schemas/AdditionalFields"}],"description":"Additional Fields"},"name":{"type":"string","description":"Name"},"usersId":{"type":"string","description":"Users Id"},"currentThreadMessageId":{"type":"string","description":"Current Thread Message Id"},"status":{"allOf":[{"$ref":"#/components/schemas/ThreadStatus"}],"description":"Status"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ThreadMessages"},"description":"Messages"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/ThreadRelationships"},"description":"Relationships"}},"description":"Threads"},"ValidationError":{"type":"object","required":["loc","msg","type"],"properties":{"loc":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"description":"Location"},"msg":{"type":"string","description":"Message"},"type":{"type":"string","description":"Error Type"}},"description":"ValidationError"},"Versions":{"type":"string","enum":["1.0"]}},"securitySchemes":{"OAuth2Auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://login.zoominfo.com","tokenUrl":"https://okta-login.zoominfo.com/oauth2/default/v1/token","scopes":{"api:agent:agentforce":"Access Agentforce integration","api:agent-teams:read":"Read Agent Teams","api:agent-teams:execute":"Execute Agent Teams and view run status","api:agent-pulses:read":"Read the authenticated user's pulses"}}}}}},"servers":[{"url":"https://api.zoominfo.com/gtm","description":"Base URL for the Agent API"}]}