Agent as a Service Spec

主题

control-plane ​

Generated reference page for spec/v1/schemas/commands/control-plane.json.

Metadata ​

  • Type: JSON Schema
  • Source: spec/v1/schemas/commands/control-plane.json
  • Raw: View Raw

Summary ​

Source ​

json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://agent-service.spec/v1/schemas/commands/control-plane.json",
  "$defs": {
    "CreateOrganizationCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["orgId", "name"],
      "properties": {
        "orgId": {
          "$ref": "../common/identity.json#/$defs/orgId"
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "status": {
          "$ref": "../common/enums.json#/$defs/organizationStatus"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "UpdateOrganizationCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "status": {
          "$ref": "../common/enums.json#/$defs/organizationStatus"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CreateAgentCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["agentId", "executionProfile"],
      "properties": {
        "agentId": {
          "$ref": "../common/identity.json#/$defs/agentId"
        },
        "card": {
          "type": "object",
          "additionalProperties": true
        },
        "executionProfile": {
          "$ref": "../common/execution-profile.json#/$defs/ExecutionProfile"
        },
        "secretRefs": {
          "type": "array",
          "items": {
            "$ref": "../common/execution-profile.json#/$defs/SecretRef"
          }
        },
        "grayscaleRules": {
          "type": "array",
          "items": {
            "$ref": "../common/execution-profile.json#/$defs/GrayscaleRule"
          }
        },
        "enabled": {
          "type": "boolean"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "UpdateAgentCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "card": {
          "type": "object",
          "additionalProperties": true
        },
        "executionProfile": {
          "$ref": "../common/execution-profile.json#/$defs/ExecutionProfile"
        },
        "secretRefs": {
          "type": "array",
          "items": {
            "$ref": "../common/execution-profile.json#/$defs/SecretRef"
          }
        },
        "grayscaleRules": {
          "type": "array",
          "items": {
            "$ref": "../common/execution-profile.json#/$defs/GrayscaleRule"
          }
        },
        "enabled": {
          "type": "boolean"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CreateToolCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["toolId", "name", "description"],
      "properties": {
        "toolId": {
          "$ref": "../common/identity.json#/$defs/toolId"
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string",
          "minLength": 1
        },
        "parametersSchema": {
          "type": "object",
          "additionalProperties": true
        },
        "resultSchema": {
          "type": "object",
          "additionalProperties": true
        },
        "executionProfile": {
          "$ref": "../common/execution-profile.json#/$defs/ExecutionProfile"
        },
        "authPolicy": {
          "type": "object",
          "additionalProperties": true
        },
        "enabled": {
          "type": "boolean"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "UpdateToolCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string",
          "minLength": 1
        },
        "parametersSchema": {
          "type": "object",
          "additionalProperties": true
        },
        "resultSchema": {
          "type": "object",
          "additionalProperties": true
        },
        "executionProfile": {
          "$ref": "../common/execution-profile.json#/$defs/ExecutionProfile"
        },
        "authPolicy": {
          "type": "object",
          "additionalProperties": true
        },
        "enabled": {
          "type": "boolean"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "ToolDescriptor": {
      "$ref": "../resources/run.json#/$defs/ToolDescriptor"
    },
    "RunInput": {
      "type": "object",
      "additionalProperties": false,
      "required": ["messages", "tools"],
      "properties": {
        "messages": {
          "type": "array",
          "items": {
            "$ref": "../resources/message-record.json#/$defs/TaskInputMessage"
          }
        },
        "tools": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": ["name", "description"],
            "properties": {
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "parametersSchema": {
                "type": "object",
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "CreateRunCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["resourceType", "resourceId", "input"],
      "properties": {
        "resourceType": {
          "$ref": "../common/enums.json#/$defs/taskResourceType"
        },
        "resourceId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "threadId": {
          "$ref": "../common/identity.json#/$defs/threadId"
        },
        "contextId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "parentRunId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "input": {
          "$ref": "#/$defs/RunInput"
        },
        "runSpaceId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "fallbackNewRunSpace": {
          "type": "boolean"
        },
        "maxRetries": {
          "type": "integer",
          "minimum": 0
        },
        "actionInputs": {
          "type": "object",
          "additionalProperties": true
        },
        "env": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "webhook": {
          "$ref": "../resources/webhook-subscription.json"
        },
        "idempotencyKey": {
          "type": "string"
        }
      }
    },
    "ContinueRunCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["messages"],
      "properties": {
        "messages": {
          "type": "array",
          "items": {
            "$ref": "../resources/message-record.json#/$defs/TaskInputMessage"
          }
        }
      }
    },
    "NotifyRunCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CancelRunCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "reason": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "FailRunCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["errorMessage"],
      "properties": {
        "errorMessage": {
          "type": "string",
          "minLength": 1
        }
      }
    },
    "SaveCheckpointCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "label": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        },
        "strategies": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        }
      }
    },
    "LoadCheckpointCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["checkpointId"],
      "properties": {
        "checkpointId": {
          "$ref": "../common/identity.json#/$defs/checkpointId"
        },
        "strategyIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}

Generated from spec source.

Agent as a Service Spec