Create a prompt template.
Operation description
This API does not currently support the creation of text-to-image prompt templates.
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
Actionelement 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
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
- 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 |
|---|---|---|---|---|
sfm:CreatePromptTemplate | create | *All Resource
| None | None |
Request syntax
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| workspaceId | string | Yes | Workspace ID. | llm-czal8nvvwb8d4xxx |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| name | string | Yes | Template name. | 小红书文案助手 |
| content | string | Yes | Prompt template content. | 请写一篇小红书种草笔记，增加丰富的emoji元素，结尾作总结，并加上相关标签。主题为：${theme} |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Schema of Response | ||
| promptTemplateId | string | Prompt template ID. | 6e49109bfeb94a39bb268f4e483ccxxx |
| requestId | string | Request ID. | FE9B6CBF-47E6-5D76-9C5D-B814DD5ABxxx |
Examples
Success response
JSON format
Error codes
HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | PromptTemplate.ContentInvalid | Input parameter Content is invalid. | The format of the input parameter Content is invalid. |
| 400 | PromptTemplate.NameInvalid | Input parameter Name is invalid. | The format of the input parameter Name is invalid. |
| 500 | PromptTemplate.InternalError | Prompt template service inner exception. | prompt template service internal exception |