Edge Developer Platform
  • Image Renderer
    • Product Introduction
    • Getting Started
    • Development Guide
      • Overview
      • Signature URL
      • API Generation
    • Open API
      • Overview
      • API Documentation
      • API List
        • Account Verification
        • Get Template List
        • Get Template Instance
        • Get Image Signed URL
    • FAQs
Docs Overview/
Edge Developer Platform/
Image Renderer/
Open API/
API List/
Get Template List/

Get Template List

Interface description

Request Domain: image.edgeone.app.
Get all template information under the user's account.
Note:
1. All interfaces require ApiKey + UserId for API authentication. The API Key is your private key. Please avoid leaking the API Key when invoking the API.
2. The RequestId in the response can be used for tracing and troubleshooting issues.

URL Path

/api/v1/DescribeTemplateList

Request method

POST

Request headers

Content-Type: application/json

Request parameters

Parameter Name
Type
Required
Description
ApiKey
string
Yes
User API Key
UserId
string
Yes
User ID

Response data type

JSON

Sample response

{
    "code": 0,
    "data": {
        "Response": {
            "List": [
                // ... Template List ...
            ]
            "TotalCount": 7
        }
    },
    "message": "ok",
    "requestId": "d00d2e0f-xxxx-xxxx-xxxx-xxxx"
}

Field description

code (int): Response status code, 0 indicates success.
data (object): Object containing the actual response data.
Response (object): Actual business response data.
List (array of objects): Template List.
Id (string): Template ID.
Name (string): Template name.
Description (string): Template description.
Format (string): Template format.
Size (string): Template size.
TemplateVariables (string): Template variables, JSON format string.
PreviewUrl (string): Template preview URL.
CreatedTime (string): Creation time.
UpdatedTime (string): Update time.
AuditStatus (string): Review status, 'normal' indicates normal, 'abnormal' indicates abnormal.
TotalCount (int): Total number of templates.
message (string): Response message.
requestId (string): Request ID.