Skip to main content

AgentInfo

HTTP API schema for AgentInfo.

{
  "type": "object",
  "required": [
    "id",
    "installed",
    "credentialsAvailable",
    "capabilities"
  ],
  "properties": {
    "capabilities": {
      "$ref": "#/components/schemas/AgentCapabilities"
    },
    "configError": {
      "type": "string",
      "nullable": true
    },
    "configOptions": {
      "type": "array",
      "items": {},
      "nullable": true
    },
    "credentialsAvailable": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "installed": {
      "type": "boolean"
    },
    "path": {
      "type": "string",
      "nullable": true
    },
    "serverStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ServerStatusInfo"
        }
      ],
      "nullable": true
    },
    "version": {
      "type": "string",
      "nullable": true
    }
  }
}

Related schemas: AgentCapabilities, ServerStatusInfo.