AgentsListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gtm/main/json-schema/gtm-agents-list-response-schema.json",
  "title": "AgentsListResponse",
  "description": "Response containing a page of the agent catalog.",
  "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/AgentsListResponse",
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Agent"
      },
      "description": "The primary data of the document"
    },
    "meta": {
      "allOf": [
        {
          "$ref": "#/$defs/CursorPagingMeta"
        }
      ],
      "description": "Non-standard meta information about the document"
    },
    "links": {
      "allOf": [
        {
          "$ref": "#/$defs/CursorPagingLinks"
        }
      ],
      "description": "Links related to the primary data"
    }
  },
  "$defs": {
    "Agent": {
      "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/AgentAttributes"
            }
          ],
          "description": "The attributes defining the resource"
        },
        "meta": {
          "allOf": [
            {
              "$ref": "#/$defs/AgentMeta"
            }
          ],
          "description": "Non-standard meta information about the resource"
        }
      },
      "description": "An agent catalog entry."
    },
    "AgentAttributes": {
      "type": "object",
      "required": [
        "name",
        "description",
        "active",
        "managedBy",
        "capabilities"
      ],
      "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."
        }
      },
      "description": "Attributes shared by every agent catalog entry."
    },
    "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."
    },
    "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."
    },
    "CursorPageInfo": {
      "type": "object",
      "required": [
        "pageSize",
        "totalCount"
      ],
      "properties": {
        "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 matching the current filters."
        }
      },
      "description": "Page details for a cursor-paged collection."
    },
    "CursorPagingLinks": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string",
          "format": "uri",
          "description": "The link that generated the current response document"
        },
        "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 for a cursor-paged collection. `next` is omitted on the last page and `prev` on the first."
    },
    "CursorPagingMeta": {
      "type": "object",
      "required": [
        "page"
      ],
      "properties": {
        "page": {
          "allOf": [
            {
              "$ref": "#/$defs/CursorPageInfo"
            }
          ],
          "description": "Page details."
        }
      },
      "description": "Metadata for a cursor-paged collection."
    }
  }
}