AgentDetailResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gtm/main/json-schema/gtm-agent-detail-response-schema.json",
  "title": "AgentDetailResponse",
  "description": "Response containing a single agent's full details.",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/gtm-agent-api-v1-api-openapi.yml#/components/schemas/AgentDetailResponse",
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "allOf": [
        {
          "$ref": "#/$defs/AgentDetail"
        }
      ],
      "description": "The primary data of the document"
    }
  },
  "$defs": {
    "AgentCapabilities": {
      "type": "object",
      "required": [
        "executionModes",
        "defaultInputModes",
        "defaultOutputModes"
      ],
      "properties": {
        "executionModes": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AgentExecutionMode"
          },
          "description": "Execution modes this agent supports; each maps to an invocation endpoint."
        },
        "defaultInputModes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "MIME types accepted as run input."
        },
        "defaultOutputModes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "MIME types the agent can produce."
        },
        "interactive": {
          "type": "boolean",
          "description": "OPTIONAL. Whether the agent can pause awaiting input (`TASK_STATE_INPUT_REQUIRED` / `TASK_STATE_AUTH_REQUIRED`) and be resumed by a follow-up run that sets `taskId`. `false` or absent (the case for every agent today) means runs are single-shot."
        }
      },
      "description": "Execution capabilities declared by the agent."
    },
    "AgentDetail": {
      "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": "#/$defs/AgentDetailAttributes"
            }
          ],
          "description": "The attributes defining the resource"
        },
        "meta": {
          "allOf": [
            {
              "$ref": "#/$defs/AgentMeta"
            }
          ],
          "description": "Non-standard meta information about the resource"
        }
      },
      "description": "An agent catalog entry with full input contract and trigger metadata."
    },
    "AgentDetailAttributes": {
      "type": "object",
      "required": [
        "name",
        "description",
        "active",
        "managedBy",
        "capabilities",
        "triggerType"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Display name of the agent."
        },
        "description": {
          "type": "string",
          "description": "What the agent does."
        },
        "version": {
          "type": "string",
          "description": "Semantic version of the agent definition. Omitted when the owning runtime does not version its agents."
        },
        "iconUrl": {
          "type": "string",
          "format": "uri",
          "description": "URL of the agent's icon image."
        },
        "active": {
          "type": "boolean",
          "description": "Whether the agent is currently active and runnable."
        },
        "managedBy": {
          "allOf": [
            {
              "$ref": "#/$defs/AgentManagedBy"
            }
          ],
          "description": "Who operates the agent."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Tags assigned to the agent. Customer-assigned for tenant agents; curated defaults for ZoomInfo-managed agents."
        },
        "capabilities": {
          "allOf": [
            {
              "$ref": "#/$defs/AgentCapabilities"
            }
          ],
          "description": "Declared execution capabilities."
        },
        "inputSchema": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AgentPartSchema"
          },
          "description": "This agent's declared input contract: an ARRAY of part schemas mirroring the run message's parts. A chat agent declares exactly [{kind: \"text\", required: true}]; an agent with structured input adds a data entry whose `schema` types that part's payload; an Agent Team declares one required data entry (Teams take no text part). ABSENT means no declared contract. Validated before a run is created -- see Start Agent Run."
        },
        "triggerType": {
          "allOf": [
            {
              "$ref": "#/$defs/AgentTriggerType"
            }
          ],
          "description": "How runs of this agent are initiated."
        },
        "scheduledDate": {
          "type": "string",
          "format": "date-time",
          "description": "Next scheduled occurrence; present only when `triggerType` is `SCHEDULED`."
        }
      },
      "description": "Full agent detail: everything from the list entry plus the declared input contract and trigger metadata."
    },
    "AgentExecutionMode": {
      "type": "string",
      "enum": [
        "SYNC",
        "STREAMING",
        "ASYNC"
      ],
      "description": "Execution modes an agent supports.",
      "x-enumDescriptions": {
        "SYNC": "The connection is held until the run completes or the synchronous window elapses; an in-progress run is returned on expiry.",
        "STREAMING": "Server-sent events streamed as the run progresses.",
        "ASYNC": "Submit and receive the in-progress run at once; retrieve the outcome via Get Agent Run. Available for every agent that supports synchronous execution."
      }
    },
    "AgentManagedBy": {
      "type": "string",
      "enum": [
        "ZOOMINFO",
        "TENANT"
      ],
      "description": "Who operates the agent. ZoomInfo-managed agents are available to every eligible tenant; tenant agents (customer-built Agent Teams) are visible only within the owning tenant.",
      "x-enumDescriptions": {
        "ZOOMINFO": "Created, hosted, and operated by ZoomInfo.",
        "TENANT": "Configured by the customer (Agent Teams); scoped to the owning tenant."
      }
    },
    "AgentMeta": {
      "type": "object",
      "properties": {
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "When the agent was created."
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "When the agent definition last changed."
        },
        "createdBy": {
          "type": "string",
          "description": "User id that created the agent (tenant agents)."
        },
        "modifiedBy": {
          "type": "string",
          "description": "User id that last modified the agent (tenant agents)."
        }
      },
      "description": "Audit metadata for an agent catalog entry. Creator/modifier fields are present for tenant agents only."
    },
    "AgentPartSchema": {
      "type": "object",
      "required": [
        "kind"
      ],
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "text",
            "data",
            "file"
          ],
          "description": "Which part this entry declares: text | data | file."
        },
        "required": {
          "type": "boolean",
          "description": "Whether a part of this kind must be present. Defaults to false."
        },
        "description": {
          "type": "string",
          "description": "Field help for consoles and adapters (e.g. the prompt's placeholder)."
        },
        "schema": {
          "type": "object",
          "additionalProperties": {},
          "description": "Data entries only: one standard JSON Schema (draft 2020-12) over the data part's payload -- the structured argument object for THIS agent. Plain JSON Schema, so standard validators and form generators apply directly."
        }
      },
      "description": "One declared part of the agent's input, discriminated by `kind` -- the\npart union's own vocabulary. At most one entry per kind: parts match\nentries BY KIND, never by position (part order carries no semantics);\narray order is the author's display order, so a prompt-first agent lists\nits text entry first."
    },
    "AgentTriggerType": {
      "type": "string",
      "enum": [
        "MANUAL",
        "SCHEDULED"
      ],
      "description": "How runs of this agent are initiated.",
      "x-enumDescriptions": {
        "MANUAL": "Runs are started by an API call.",
        "SCHEDULED": "Runs are started on a schedule; `scheduledDate` carries the next occurrence."
      }
    }
  }
}