PromptInput

An input a run is started with, filled into the interaction’s prompt wherever it says %%name%%.

Kind: an object, used in requests and responses. In a request it is called PromptInputInput.

In a request

Field	Type	Required	Description
`dataType`	`InteractionInputType`		The type of value the input takes.
`name`	`string`	yes	The input’s name: a run gives the input’s value under this name. Constraints: required (empty or whitespace-only strings are rejected).
`description`	`string \| null`		What the input is for, shown to whoever starts a run. Constraints: minLength: 1.
`isRequired`	`boolean`		Whether a run must give the input. A run started without a required input is refused.

{
  "dataType": "String",
  "name": "...",
  "description": "...",
  "isRequired": false
}

Every field is present in a response; empty ones are null.

Field	Type	Description
`dataType`	`InteractionInputType`	The type of value the input takes.
`name`	`string`	The input’s name: a run gives the input’s value under this name. Constraints: required (empty or whitespace-only strings are rejected).
`description`	`string \| null`	What the input is for, shown to whoever starts a run. Constraints: minLength: 1.
`isRequired`	`boolean`	Whether a run must give the input. A run started without a required input is refused.

{
  "dataType": "String",
  "name": "...",
  "description": "...",
  "isRequired": false
}