SendAIAgentSpeech API Guide for Real-Time AI Broadcasts - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Operation description

You can use this API to immediately instruct an AI agent instance to perform voice playback by passing in the specified text content. You can optionally allow this playback to interrupt any currently playing audio. By default, interruption is allowed.

Note:

The InstanceId must be valid and correspond to an existing agent instance.
The Text content must comply with specifications and must not contain sensitive or inappropriate information.
If you do not want the new playback to interrupt the current audio, you must explicitly set EnableInterrupt to false.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:SendAIAgentSpeech

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Agent instance ID. Note The InstanceId is the unique ID returned after successfully starting an agent instance. For details about starting an agent instance, see StartAIAgentInstance and GenerateAIAgentCall.	39f8e0bc005e4f309379701645f4****
Text	string	Yes	The text content to be played back. The supported input format varies based on the Type parameter. The length cannot exceed 1024 characters.	Hello, welcome to use our service
EnableInterrupt	boolean	No	Specifies whether the broadcast can interrupt the ongoing speech. Default value: true	true
Type	string	No	Input type. Valid values: Text: Input is plain text. AudioUrl: Input is an audio URL. Default value: Text.	Text

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID	7B117AF5-2A16-412C-B127-FA6175ED1AD0

Examples

Success response

JSON format

{
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.