ApiInvocationInput

Contains information about the API operation that the agent predicts should be called.

This data type is used in the following API operations:

actionGroup

The action group that the API operation belongs to.

Type: String

Required: Yes

actionInvocationType

Contains information about the API operation to invoke.

Type: String

Valid Values: RESULT | USER_CONFIRMATION | USER_CONFIRMATION_AND_RESULT

Required: No

agentId

The agent's ID.

Type: String

Required: No

apiPath

The path to the API operation.

Type: String

Required: No

collaboratorName

The agent collaborator's name.

Type: String

Pattern: ([0-9a-zA-Z][_-]?){1,100}

Required: No

httpMethod

The HTTP method of the API operation.

Type: String

Required: No

parameters

The parameters to provide for the API request, as the agent elicited from the user.

Type: Array of ApiParameter objects

Required: No

requestBody

The request body to provide for the API request, as the agent elicited from the user.

Required: No

Contents