Generate Marketing Copies at Scale via IMS Text API - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Generates marketing copy based on the provided keywords, text length, and number of copy variations. Due to the complexities of the Chinese language, the length of the output text may differ from the requested length. After submitting the job, call the GetSmartHandleJob operation with the returned job ID to query the job status and retrieve the results.

Operation description

Before you call this operation, you must purchase the enterprise subscription service to obtain the required permissions.
This operation is billed based on the number of tokens in the generated content. The number of tokens is positively correlated with the number of characters in the generated text. For more information, see smart video creation. No charges are incurred for failed jobs.
This is an asynchronous API. After you submit a job, the operation returns a job ID. The job is then queued for background processing. The service delivers results via a callback. You can also call GetSmartHandleJob to actively poll for the job status.

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:SubmitTextGenerateJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Title	string	No	The job title. - The maximum length is 128 bytes. - UTF-8 encoding is required.	测试标题
Description	string	No	The job description, with a maximum length of 1,024 bytes (UTF-8 encoded).	测试描述
Type	string	No	The job type. Valid values: `MarketingCopy`: Generates marketing copy. `Title`: Generates a short video title. `StoryboardScript`: Generates a storyboard script from text. Valid values: MarketingCopy : marketing copy Title : short video title	MarketingCopy
GenerateConfig	string	No	The generation configuration, in JSON format. If `Type` is set to `Title` or `MarketingCopy`, specify the following fields: `keywords`: The keywords used to generate the title or marketing copy. This parameter is required. `textLength`: The target length of the generated text, in characters. Valid values: 5 to 1,000. The actual length of the output is less than or equal to this value. This parameter is required. `targetCount`: The number of copy variations to generate. Valid values: 1 to 1,000. This parameter is required. If `Type` is set to `StoryboardScript`, specify the following field: `originText`: The original text used to generate the storyboard script. This parameter is required.	{"keywords":"新开店蛋糕，动物奶油","textLength":100,"targetCount":3} 或 {"originText": "街边新开了一家蛋糕店，售卖奶油蛋糕、水果蛋糕、面包、松饼等。蛋糕店对面开了一家咖啡馆，客人络绎不绝。"}
UserData	string	No	The custom settings in JSON format. The maximum length is 512 bytes. You can use this parameter to specify a custom callback address.	{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
JobId	string	The smart job ID.	**d80e4e4044975745c14b**

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****d80e4e4044975745c14b****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.