Add a Summary Template

Request URL

POST {base_url}/uc-ai/api/v1/summary-templates

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer `{access_token}`.
x-tenant-code	Yes	String	The tenant name. Note: You can obtain tenant name using the Query Tenants interface.

Body parameters


Parameter	Required	Type	Description
name	Yes	String	The name of the summary template.
keyPoints	No	Array<String>	The list of summary key points, with up to 3 items and a maximum of 64 characters per item.
summaryDescription	Yes	String	The summary description or prompt.

Response parameters


Parameter	Type	Description
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
code	String	The HTTP status code of the request. `200`: Request succeeded. Non-200 value: Request failed.
message	String	The status message of the request.
detailMessage	String	The detailed error information. When the request is successful, this parameter returns empty.
result	Object<Summary_Template>	The created custom summary template.

Summary_Template


Parameter	Type	Description
id	String	The ID of the summary template.
name	String	The name of the summary template.
keyPoints	Array<String>	The list of key points for the summary.
summaryDescription	String	The summary description or prompt.
type	String	The type of the template. `SYSTEM`: The built-in system template. `CUSTOM`: The custom template.
isDefault	Boolean	Whether the template is the tenant's default summary template.
createTime	String	The creation time, in Unix timestamp format (milliseconds).
updateTime	String	The last update time, in Unix timestamp format (milliseconds).

Example

Request example

POST /uc-ai/api/v1/summary-templates HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MjU2NzI3NywiaWF0IjoxNzkyNTQ1Njc3LCJqdGkiOiJlMmNkNjE5Ny1iNGY3LTQ2ZjItOTU5NC0wODBiYmEyYmI2YWYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.gcSnhONW7FfAWhnidO-5j8BL_670vVJMfyunKycxtSyTjcEXkia6o8unfZT7zwoIvrR9SEhcLVkGis_sUxMIVLeZuTeBMuny0kU3pzuYt8QJ531OT1YnrVw0uZcmRNmvVIVe9MfnPYeH3QONM7vZFYnHoN41cKKEEnYaHAXVQINKBHzzAiYGdt0ykRCJBsJIar8DbelygFpZvnsK2uCMNgEhatZdghlFTdv1pu7juPB1hyV9Lanx7FQDn4yx8uUwKQWBPITtuNnp6UAuwxnOq0b-XmYz689yyDSXUw09C_w05lKU6km3QUKtRuQjGz-Wr2pBPU-U1ajr6CU7nJO0ag
x-tenant-code: jint
Content-Type: application/json
{
  "name": "aitdoc-template",
  "keyPoints": [
    "Caller intent",
    "Resolution status"
  ],
  "summaryDescription": "Summarize the call: intent, actions, outcome."
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "id": "2112715819776798721",
    "name": "aitdoc-template",
    "keyPoints": [
      "Caller intent",
      "Resolution status"
    ],
    "summaryDescription": "Summarize the call: intent, actions, outcome.",
    "type": "CUSTOM",
    "createTime": 1792545678453,
    "updateTime": 1792545678453
  },
  "requestId": "36b7da446b89d5cde6afdba977e2c8b5",
  "code": "200",
  "message": "SUCCESS"
}