Prompt Template Overview

​

Workflow

1. Create a template: Create and save a template via the Alibaba Cloud Bailian console or API, obtaining a unique template ID.
2. Retrieve the template: Fetch the template content using the API and its template ID.
3. Generate a Prompt: Populate template variables with business data to produce the final Prompt.
4. Use the template: Send the generated Prompt to the target LLM to obtain results.

​

Template Types

​

Predefined Prompt Templates

​

Viewing

​

Viewing & Managing

• View: Click View Details on a template card to open a side drawer showing the template's name, category, content, variables, template ID, and API information (code examples).
• Copy template content: Click Copy to copy the full template content.
• Create an application: Click More icon (···), then select Create Application to auto-populate the prompt editor with the template. You may use it as-is or adapt it to your business context. The pre-filled prompt includes custom variables like ${number} and ${content}, designed for generating Xiaohongshu-style copy.
• Copy to custom template: Click More icon (···), then select Copy Template, or click Copy to Custom Template in the details drawer, to create a custom template named "[Original Template Name]_Copy_[Timestamp]" on the Prompt Management page.
• Code example: In the API information area of the details drawer, view core SDK usage code. Note: This is a minimal working snippet—not executable standalone. For complete, runnable examples, refer to the SDK section under GetPromptTemplate – Retrieve a Prompt Template.

​

Custom Prompt Templates

​

Creation

• Based on a predefined template: On any predefined template card, click More icon (···), then select Copy Template, or click Copy to Custom Template in the details drawer, to generate a custom copy named "[Predefined Template Name]_Copy_[Timestamp]".
• From scratch: On the Prompt Management page, click Create Prompt in the top-right corner, complete the configuration, and save the template. On the Prompt Template Management page, filter templates by type (All, Text Generation, Image Generation) or search by keyword. Created templates appear as cards showing title, content preview, and template ID—and support Edit and Copy.

• Obtain your workspace ID: see Get workspace ID.
• Create a custom template: use the CreatePromptTemplate operation.

​

Viewing & Managing

• View: After creation, custom templates appear on the Prompt Management page.
• Manage:
  • Click Edit on a template card to modify its content.
  • Click Copy to copy the full template content.
  • Click More icon (···), then select Create Application to auto-populate the prompt editor. Use as-is or adapt further.
  • Click View Details to view core SDK usage code in the side drawer. Note: This is a minimal working snippet—not executable standalone. For complete, runnable examples, refer to the SDK section under GetPromptTemplate – Retrieve a Prompt Template.
  • Click More icon (···), then select Copy Template to create a new custom template named "[Custom Template Name]_Copy_[Timestamp]".
  • Click More icon (···), then select Delete to remove the template permanently.

​

Using Prompt Templates

​

Console

​

API

1. Open the GetPromptTemplate API reference, then click Try It Out.
2. Enter your workspaceId and promptTemplateId in the corresponding fields:
   • workspaceId: Your business workspace ID. See Get workspace ID.
   • promptTemplateId: The ID of either a predefined or custom template—found directly on its template card.
3. Click Send Request to invoke and debug the API online.

{
  "variables": ["platform", "topic", "num1", "num2"],
  "promptTemplateId": "cfec40c311f14f3e976403059d8f0116",
  "requestId": "8C616xxx",
  "name": "Marketing Copy Generator",
  "content": "You are a professional viral marketing copywriter experienced on the ${platform} platform. Now, craft compelling marketing content centered around \"${topic}\". Requirements: (1) An SEO-optimized, attention-grabbing headline; (2) A detailed, emotionally engaging body paragraph. Within the body, include at least ${num1} distinct emoji symbols to boost interactivity and visual appeal. Also, suggest up to ${num2} trending hashtags highly relevant to the topic and appealing to the target audience."
}

​

SDK

1. Open the GetPromptTemplate API reference, then click Try It Out.
2. Enter your workspaceId and promptTemplateId. Upon configuration, these values auto-populate in the SDK code samples.
   • workspaceId: Your business workspace ID. See Get workspace ID.
   • promptTemplateId: The ID of either a predefined or custom template—found directly on its template card.
3. Click SDK Examples, then choose to:
   • Run the example online, or
   • Download the full project, configure accessKeyId and accessKeySecret, and run locally. See Create an AccessKey pair for setup instructions.
4. On the OpenAPI debugging page, click the SDK Examples tab on the right. Select SDK Version 2.0 (Recommended) and your preferred language (e.g., Java) to view the corresponding SDK code.

​

Production Deployment Best Practices

​

Sample Outputs

​

Error Codes

​

Frequently Asked Questions