Object

Object inputs allow users to provide JSON objects.

Common usage

The object input type can be used for:

• Configuration objects
• Custom metadata
• Key-value pairs
• Complex structured data

Definition

Basic

{
  "metadata": {
    "title": "Metadata",
    "description": "Additional metadata",
    "type": "object"
  }
}

With schema

{
  "config": {
    "title": "Configuration",
    "description": "Service configuration",
    "type": "object",
    "properties": {
      "replicas": {
        "type": "number"
      },
      "memory": {
        "type": "string"
      }
    },
    "required": ["replicas"]
  }
}

Labeled URL

{
  "documentationLink": {
    "title": "Documentation Link",
    "description": "Link to documentation",
    "type": "object",
    "format": "labeled-url"
  }
}

A labeled URL has the structure:

{
  "url": "https://docs.example.com",
  "displayText": "Documentation"
}

Properties

Property	Type	Description
type	"object"	Required. Must be "object"
format	"none" | "labeled-url"	Optional format
default	object	Default object value
properties	object	JSON Schema for object properties
required	string[]	Required properties within the object
additionalProperties	boolean	Whether to allow properties not in schema