sql.v1.AgentList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/confluent/main/json-schema/confluent-sql-v1-agent-list-schema.json",
  "title": "sql.v1.AgentList",
  "description": "A list of Agent resources.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/confluent-agents-sql-v1-api-openapi.yml#/components/schemas/sql.v1.AgentList",
  "type": "object",
  "required": [
    "api_version",
    "kind",
    "metadata",
    "data"
  ],
  "properties": {
    "api_version": {
      "type": "string",
      "enum": [
        "sql/v1"
      ],
      "readOnly": true
    },
    "kind": {
      "type": "string",
      "enum": [
        "AgentList"
      ],
      "readOnly": true
    },
    "metadata": {
      "$ref": "#/$defs/ListMeta"
    },
    "data": {
      "type": "array",
      "description": "A data property that contains an array of resource items. Each entry in the array is a separate resource.",
      "items": {
        "$ref": "#/$defs/sql.v1.Agent"
      },
      "uniqueItems": true
    }
  },
  "$defs": {
    "ListMeta": {
      "type": "object",
      "description": "ListMeta describes metadata that resource collections may have",
      "properties": {
        "first": {
          "description": "A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported.",
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "last": {
          "description": "A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported.",
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "prev": {
          "description": "A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported.",
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "next": {
          "description": "A link to the next page of results. If a response does not contain a next link, then there is no more data available.",
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "total_size": {
          "description": "Number of records in the full result set. This response may be paginated and have a smaller number of records.",
          "type": "integer",
          "format": "int32",
          "minimum": 0
        }
      }
    },
    "ObjectMeta": {
      "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "description": "Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time",
          "type": "string",
          "format": "uri",
          "readOnly": true
        },
        "resource_name": {
          "description": "Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name",
          "type": "string",
          "format": "uri",
          "readOnly": true
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true,
          "description": "The date and time at which this object was created. It is represented in RFC3339 format and is in UTC."
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true,
          "description": "The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC."
        },
        "deleted_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true,
          "description": "The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC."
        }
      },
      "readOnly": true
    },
    "sql.v1.Agent": {
      "type": "object",
      "description": "Represents an Agent resource.",
      "required": [
        "api_version",
        "kind",
        "metadata",
        "name",
        "organization_id",
        "environment_id",
        "spec"
      ],
      "properties": {
        "api_version": {
          "type": "string",
          "enum": [
            "sql/v1"
          ],
          "description": "APIVersion defines the schema version of this representation of a resource.",
          "readOnly": true
        },
        "kind": {
          "type": "string",
          "description": "Kind defines the object this REST resource represents.",
          "enum": [
            "Agent"
          ],
          "readOnly": true
        },
        "metadata": {
          "allOf": [
            {
              "$ref": "#/$defs/ObjectMeta"
            },
            {
              "type": "object",
              "properties": {
                "self": {},
                "uid": {},
                "resource_version": {},
                "resource_name": {},
                "labels": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              }
            }
          ]
        },
        "name": {
          "type": "string",
          "description": "The user-provided name of the agent, unique within this environment.",
          "pattern": "[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*",
          "maxLength": 100,
          "x-immutable": true
        },
        "organization_id": {
          "type": "string",
          "format": "uuid",
          "description": "The unique identifier for the organization.",
          "x-immutable": true,
          "readOnly": true
        },
        "environment_id": {
          "type": "string",
          "description": "The unique identifier for the environment.",
          "x-immutable": true,
          "readOnly": true
        },
        "spec": {
          "$ref": "#/$defs/sql.v1.AgentSpec"
        },
        "status": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/$defs/sql.v1.AgentStatus"
            }
          ]
        }
      }
    },
    "sql.v1.AgentSpec": {
      "type": "object",
      "description": "The specifications of the Agent.",
      "properties": {
        "description": {
          "type": "string",
          "description": "The description of the agent."
        },
        "model": {
          "type": "string",
          "description": "The name of the model the agent uses for inferencing."
        },
        "prompt": {
          "type": "string",
          "description": "The instruction prompt that guides the agent's behavior.",
          "maxLength": 65536
        },
        "tools": {
          "type": "array",
          "description": "The list of tools available to the agent.",
          "items": {
            "type": "string"
          }
        },
        "properties": {
          "type": "object",
          "description": "A set of key-value option pairs that configure the agent's behavior.",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    },
    "sql.v1.AgentStatus": {
      "type": "object",
      "description": "The status of the Agent.",
      "properties": {
        "phase": {
          "type": "string",
          "x-extensible-enum": [
            "READY",
            "RUNNING"
          ],
          "description": "Describes the status of the agent:\n\nREADY: The Agent is created;\n\nRUNNING: The Agent is created and running in a query;\n"
        }
      }
    }
  }
}