HTTP API
AgentParameter
A single named placeholder an AgentDefinition’s instructions can
reference as {{name}}.
Shape: object
| Property | Required | Type | Description | Rules |
|---|---|---|---|---|
name |
yes | string |
Gets the parameter name, as referenced by {{name}} in the instructions text. |
— |
kind |
yes | AgentParameterKind |
Gets the parameter’s data kind. | — |
required |
no | boolean |
Gets whether a run must supply this parameter. A run missing a required parameter with no DefaultValue does not start. |
— |
defaultValue |
no | string |
Gets the value used when a run does not supply this parameter. Applies whether or not Required is set. |
— |
description |
no | string |
Gets a short description shown to the person authoring a run. | — |