tencent cloud

APIs

Cloud Virtual Machine
History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Tencent Cloud Lighthouse
History
Introduction
API Category
Making API Requests
Image APIs
Firewall APIs
Key APIs
Instance APIs
CCN APIs
Snapshot APIs
Other APIs
Cloud Disk APIs
Scene APIs
Package APIs
Quota APIs
Region APIs
Data Types
Error Codes
Auto Scaling
History
Introduction
API Category
Making API Requests
Scaling Group APIs
Scaling Group Instances APIs
Launch Configuration APIs
Scheduled Action APIs
Alarm Trigger Policy APIs
Notification APIs
Lifecycle Hook APIs
Instance Refresh APIs
Other APIs
Data Types
Error Codes
Batch Compute
History
Introduction
API Category
Making API Requests
Compute Environment APIs
Configuration Viewing-related APIs
Task Template-related APIs
Job-related APIs
Data Types
Error Codes
Tencent Cloud Automation Tools
History
Introduction
API Category
Making API Requests
Remote Command APIs
Scheduled Execution APIs
Managed Instance APIs
Scenario APIs
Statistics APIs
Data Types
Error Codes
Edge Computing Machine
History
API Category
Making API Requests
Region APIs
Module APIs
Instance APIs
Image APIs
VPC APIs
Subnet APIs
Route Table APIs
CLB APIs
ENI APIs
EIP APIs
HAVIP APIs
Other API
Key APIs
Security Group APIs
Data Types
Error Codes
Tencent Kubernetes Engine
History
Introduction
API Category
Making API Requests
Elastic Cluster APIs
Resource Reserved Coupon APIs
Cluster APIs
Third-party Node APIs
Relevant APIs for Addon
Network APIs
Node APIs
Node Pool APIs
TKE Edge Cluster APIs
Cloud Native Monitoring APIs
Scaling group APIs
Super Node APIs
Other APIs
Data Types
Error Codes
TKE API 2022-05-01
Tencent Container Registry
History
Introduction
API Category
Making API Requests
Instance Management APIs
Namespace APIs
Access Control APIs
Instance Synchronization APIs
Tag Retention APIs
Trigger APIs
Helm Chart APIs
Image Repository APIs
Custom Account APIs
Data Types
Error Codes
Tencent Cloud Elastic Microservice
History
Introduction
API Category
Making API Requests
Environment APIs
ModifyIngress
Resource APIs
Application APIs
Service APIs
Application Deployment APIs
Access Policy APIs
Configuration file APIs
Log collecting APIs
Scaling Rule APIs
Application Version APIs
Other APIs
Workload APIs
Data Types
Error Codes
Serverless Cloud Function
History
Introduction
API Category
Making API Requests
Other APIs
Namespace APIs
Layer Management APIs
Async Event Management APIs
Trigger APIs
Function APIs
Function and Layer Status Description
Data Types
Error Codes
Event Bridge
History
Introduction
API Category
Making API Requests
Delivery Target APIs
Event Bus APIs
Event Rule APIs
Event Connector APIs
Data Transformer APIs
Event Storage APIs
Data Types
Error Codes
Cloud Object Storage
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
Cloud File Storage
History
Introduction
API Category
Snapshot APIs
File system APIs
Lifecycle APIs
Other APIs
Data Flow APIs
Making API Requests
Permission Group APIs
Service APIs
Scaling APIs
Data Migration APIs
Data Types
Error Codes
Cloud Block Storage
History
Introduction
API Category
Making API Requests
Snapshot APIs
Cloud Disk APIs
Data Types
Error Codes
Cloud HDFS
History
Introduction
API Category
Making API Requests
Other APIs
Permission group APIs
Permission rule APIs
Mount point APIs
Lifecycle rule APIs
File system APIs
Restoration task APIs
Data Types
Error Codes
Cloud Log Service
History
Introduction
API Category
Making API Requests
Topic Management APIs
Log Set Management APIs
Index APIs
Topic Partition APIs
Machine Group APIs
Collection Configuration APIs
Log APIs
Metric APIs
Alarm Policy APIs
Data Processing APIs
Kafka Protocol Consumption APIs
Kafka Task APIs
Kafka Data Subscription APIs
COS Task APIs
SCF Delivery Task APIs
Scheduled SQL Analysis APIs
COS Data Import Task APIs
Data Types
Error Codes
TDSQL-C for MySQL
History
Introduction
API Category
Making API Requests
Instance APIs
Multi-Availability Zone APIs
Other APIs
Audit APIs
Database Proxy APIs
Backup and Recovery APIs
Parameter Management APIs
Billing APIs
serverless APIs
Resource Package APIs
Account APIs
Performance Analysis APIs
Data Types
Error Codes
TencentDB for MySQL
History
Introduction
API Category
Instance APIs
Making API Requests
Data Import APIs
Database Proxy APIs
Database Audit APIs
Security APIs
Task APIs
Backup APIs
Account APIs
Rollback APIs
Parameter APIs
Database APIs
Monitoring APIs
Log-related API
Data Types
Error Codes
TencentDB for MariaDB
History
Introduction
API Category
Making API Requests
Security Group APIs
Other APIs
Account APIs
Parameter Management APIs
Monitoring Management APIs
Instance Management APIs
Backup and Restoration APIs
Data Types
Error Codes
TencentDB for PostgreSQL
History
Introduction
API Category
Making API Requests
Instance APIs
Read-only Replica APIs
Backup and Recovery APIs
Parameter Management APIs
Security Group APIs
Performance Optimization APIs
Account APIs
Specification APIs
Network APIs
Data Types
Error Codes
TencentDB for SQL Server
History
Introduction
API Category
Making API Requests
Sales and fee related APIs
Instance Management related APIs
Operation and maintenance management related APIs
Network management related APIs
Account management related APIs
Database management related APIs
Security group management related APIs
Data security encryption related APIs
Parameter configuration related APIs
Extended Event related APIs
Log management related APIs
Read only instance management related APIs
Publish and subscribe related APIs
Backup related APIs
Data migration (cold standby migration) related APIs
Rollback related APIs
Data migration (DTS old version) related APIs
SQL Server Integration Services (SSIS) related APIs
Data Types
Error Codes
TDSQL for MySQL
History
Introduction
API Category
Security Group APIs
Other APIs
Making API Requests
TDSQL APIs
Data Types
Error Codes
Tencent Cloud Distributed Cache (Redis OSS-Compatible)
History
Introduction
API Category
Making API Requests
Instance APIs
Parameter Management APIs
Other APIs
Backup and Restoration APIs
Region APIs
Monitoring and Management APIs
Log APIs
Data Types
Error Codes
TencentDB for MongoDB
History
Introduction
API Category
Making API Requests
Instance APIs
Backup APIs
Account APIs
Other APIs
Task APIs
Introduction
Data Types
Error Codes
TencentDB for TcaplusDB
History
Introduction
API Category
Making API Requests
Table Group APIs
Other APIs
Table APIs
Cluster APIs
Data Types
Error Codes
Data Transfer Service
History
Introduction
API Category
Making API Requests
(NewDTS) Data Migration APIs
Data Sync APIs
Data Consistency Check APIs
(NewDTS) Data Subscription APIs
Data Types
Error Codes
DTS API 2018-03-30
TencentDB for DBbrain
History
Introduction
Introduction
API Category
Making API Requests
Session Killing APIs
Exception Detection APIs
Other APIs
Redis related APIs
Health Report Email Sending APIs
Space Analysis APIs
Security Audit APIs
Slow Log Analysis APIs
Database Audit APIs
Data Types
Error Codes
DBbrain APIs 2019-10-16
Virtual Private Cloud
History
Introduction
API Category
Making API Requests
VPC APIs
Route Table APIs
Elastic Public IP APIs
Elastic IPv6 APIs
Highly Available Virtual IP APIs
ENI APIs
Bandwidth Package APIs
NAT Gateway APIs
Direct Connect Gateway APIs
Cloud Connect Network APIs
Network ACL APIs
Network Parameter Template APIs
Network Detection-Related APIs
Flow Log APIs
Gateway Traffic Monitor APIs
Private Link APIs
Traffic Mirroring APIs
Other APIs
Subnet APIs
VPN Gateway APIs
Security Group APIs
Snapshot Policy APIs
Error Codes
Data Types
Cloud Load Balancer
History
Introduction
API Category
Instance APIs
Listener APIs
Backend Service APIs
Target Group APIs
Redirection APIs
Other APIs
Classic CLB APIs
Load Balancing APIs
Making API Requests
Data Types
Error Codes
CLB API 2017
Direct Connect
History
Introduction
API Category
Making API Requests
Direct Connect APIs
Data Types
Error Codes
Content Delivery Network
History
Introduction
API Category
Content Management APIs
Real-time Log APIs
Service Query APIs
Data Query APIs
Making API Requests
Log Query APIs
Domain Name Management APIs
Configuration Management APIs
Obsoleted APIs
Other APIs
Data Types
Error Codes
Global Application Acceleration Platform
History
Introduction
API Category
Rule APIs
Connection Group APIs
Making API Requests
Origin Server APIs
Listener APIs
Connection APIs
Certificate APIs
Other APIs
Data Types
Error Codes
Tencent Cloud Firewall
History
Introduction
API Category
Making API Requests
Intrusion Defense APIs
Access Control APIs
Other APIs
Enterprise Security Group APIs
Firewall Status APIs
Data Types
Error Codes
Tencent Cloud EdgeOne
History
Introduction
API Category
Making API Requests
Site APIs
Acceleration Domain Management APIs
Site Acceleration Configuration APIs
Edge Function APIs
Alias Domain APIs
Security Configuration APIs
Layer 4 Application Proxy APIs
Content Management APIs
Data Analysis APIs
Log Service APIs
Billing APIs
Certificate APIs
Origin Protection APIs
Load Balancing APIs
Diagnostic Tool APIs
Custom Response Page APIs
API Security APIs
DNS Record APIs
Content Identifier APIs
Legacy APIs
Ownership APIs
Image and Video Processing APIs
Multi-Channel Security Gateway APIs
Version Management APIs
Data Types
Error Codes
Cloud Workload Protection Platform
History
Introduction
API Category
Asset Management APIs
Virus Scanning APIs
Abnormal Log-in APIs
Password Cracking APIs
Malicious Request APIs
High-Risk Command APIs
Local Privilege Escalation APIs
Reverse Shell APIs
Vulnerability Management APIs
New Baseline Management APIs
Baseline Management APIs
Advanced Defense APIs
Security Operation APIs
Expert Service APIs
Other APIs
Overview Statistics APIs
Settings Center APIs
Making API Requests
Intrusion Detection APIs
Data Types
Error Codes
Key Management Service
History
Introduction
API Category
Key APIs
Making API Requests
Asymmetric Key APIs
Data Types
Error Codes
Secrets Manager
History
Introduction
API Category
Making API Requests
Data Security APIs
Other APIs
Data Types
Error Codes
Captcha
History
Introduction
API Category
Making API Requests
Server APIs
Error Codes
Customer Identity and Access Management
History
Introduction
API Category
Making API Requests
User Management APIs
Data Sync APIs
Audit Management APIs
Data Types
Error Codes
Security Token Service
History
Introduction
API Category
Making API Requests
STS APIs
Data Types
Error Codes
SSL Certificates
History
Introduction
API Category
Making API Requests
Certificate APIs
Certificate Renewal (Certificate ID Unchanged) APIs
CSR APIs
Data Types
Error Codes
Private DNS
History
Introduction
API Category
Making API Requests
Private DNS APIs
Data Types
Error Codes
DNSPod
History
Introduction
API Category
Making API Requests
Line APIs
Package and Value-Added Service APIs
Batch Operation APIs
Group APIs
Record APIs
DNS Query Volume APIs
Alias APIs
Domain APIs
Data Types
Error Codes
Elastic MapReduce
History
Introduction
API Category
Cluster Resource Management APIs
Cluster Services APIs
User Management APIs
Data Inquiry APIs
Scaling APIs
Configuration APIs
Other APIs
Serverless HBase APIs
YARN Resource Scheduling APIs
Making API Requests
Data Types
Error Codes
Elasticsearch Service
History
Introduction
API Category
Instance APIs
Making API Requests
Data Types
Error Codes
Data Lake Compute
History
Introduction
API Category
Making API Requests
Data Table APIs
Task APIs
Metadata APIs
Service Configuration APIs
Permission Management APIs
Database APIs
Data Source Connection APIs
Data Optimization APIs
Data Engine APIs
Resource Group for the Standard Engine APIs
Data Types
Error Codes
Face Recognition
History
Introduction
API Category
Making API Requests
Face Detection and Analysis APIs
Facial Feature Localization APIs
Face Comparison APIs
Group Management APIs
Face Search APIs
Face Verification APIs
Image-based Liveness Detection (High Precision) APIs
Data Types
Error Codes
eKYC
History
Introduction
API Category
Making API Requests
Selfie Verification (Pure API) APIs
Selfie Verification (App SDK) APIs
Identity Verification (App SDK) APIs
Identity Verification(Mobile HTML5) APIs
AI Face Shield (Pure API) APIs
Other APIs
Data Types
Error Codes
Text To Speech
History
Introduction
API Category
Making API Requests
General Text-to-Speech APIs
Data Types
Error Codes
Tencent Machine Translation
History
Introduction
API Category
Making API Requests
APIs
Error Codes
Optical Character Recognition
History
Introduction
API Category
Making API Requests
Document Intelligent APIs
Card and Document OCR APIs
General Text OCR APIs
Vehicle Scene OCR APIs
Data Types
Error Codes
IoT Hub
History
Introduction
API Category
Making API Requests
Device Shadow APIs
Device APIs
CA Certificate APIs
Product APIs
Data Types
Error Codes
TDMQ for CKafka
History
Introduction
API Category
Making API Requests
Other APIs
ACL APIs
Instance APIs
Routing APIs
DataHub APIs
Topic APIs
Data Types
Error Codes
Cloud Message Queue
History
API Category
Making API Requests
Topic APIs
Queue APIs
Introduction
Data Types
Error Codes
Chat
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C APIs
C++
Short Message Service
History
Introduction
API Category
Making API Requests
SMS Mobile Number APIs
SMS Conversion Rate APIs
Status Pull APIs
SMS Statistics APIs
SMS Signature APIs
SMS Delivery APIs
SMS Template APIs
Data Types
Error Codes
SMS Callback APIs
Tencent Push Notification Service
Overview
API Overview
Call Method
Push APIs
Tag APIs
Account APIs
Statistics APIs
User Attribute APIs
Server-Side Error Codes
Server SDKs
API (Java)
Simple Email Service
History
Introduction
API Category
Making API Requests
Domain Verification APIs
Mail APIs
Template APIs
Statistics APIs
Sender Address APIs
Blocklist APIs
Sending Status Query APIs
Batch Task APIs
Custom Blocklist APIs
Data Types
Error Codes
Tencent Real-Time Communication
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
StreamLive
History
Introduction
API Category
Making API Requests
Input Management APIs
Input Security Group Management APIs
Channel Management APIs
Plan APIs
Watermark Management APIs
Statistics APIs
Data Types
Error Codes
StreamPackage
History
Introduction
API Category
Making API Requests
Channel Management APIs
Advertising Insertion Configuration Management APIs
Channel linear assembly management APIs
VOD remux task APIs
Usage Query APIs
HarvestJob Management APIs
Data Types
Error Codes
StreamLink
History
API Category
Making API Requests
Flow APIs
Data Types
Error Codes
Cloud Streaming Services
History
Introduction
API Category
Making API Requests
Live Pad APIs
Live Stream Mix APIs
Time Shifting APIs
Monitoring Data Query APIs
Billing Data Query APIs
Live Transcoding APIs
Delayed Playback Management APIs
Domain Name Management APIs
Watermark Management APIs
Certificate Management APIs
Stream Pulling APIs
Recording Management APIs
Live Callback APIs
Screencapturing and Porn Detection APIs
Authentication Management APIs
Live Stream Management APIs
Data Types
Error Codes
Video on Demand
History
Introduction
API Category
Other APIs
Media Processing APIs
Task Management APIs
Media Upload APIs
Media Management APIs
Event Notification Relevant API
Media Categorization APIs
Domain Name Management APIs
Distribution APIs
AI-based Sample Management APIs
Region Management APIs
Data Statistics APIs
Carousel-Related APIs
Just In Time Transcode APIs
No longer recommended APIs
Making API Requests
AI-based image processing APIs
Parameter Template APIs
Task Flow APIs
Data Types
Error Codes
Video on Demand API 2024-07-18
Media Processing Service
History
Introduction
API Category
Making API Requests
Processing Task Initiation APIs
Task Management APIs
Transcoding and Enhancement Template APIs
Watermark Template APIs
Screenshot Template APIs
Media AI Template APIs
Media AI—Hotword Lexicon APIs
Media AI—Sample Management APIs
Media Quality Inspection Template APIs
Live Streaming Recording Template APIs
Orchestration Management APIs
Data Statistics APIs
StreamLink—Security Group Management APIs
Other APIs
Image Processing Template APIs
AI Generation APIs
Other APIs
Data Types
Error Codes
Cloud Application Rendering
History
Introduction
API Category
Making API Requests
User APIs
Application Management APIs
Project Management APIs
Concurrency Management APIs
Stream Push Service APIs
Data Types
Error Codes
Game Multimedia Engine
History
Introduction
API Category
Usage APIs
Recording APIs
Making API Requests
Voice Chat APIs
Application APIs
Data Types
Error Codes
Tag
History
Introduction
API Category
Making API Requests
Write APIs
Read APIs
Project APIs
Data Types
Error Codes
Cloud Access Management
History
Introduction
API Category
Making API Requests
User APIs
Policy APIs
Role APIs
Identity Provider APIs
Data Types
Error Codes
CloudAudit
History
Introduction
API Category
Calling Method
CloudAudit APIs
Data Types
Error Codes
Tencent Cloud Organization
History
Introduction
API Category
Making API Requests
Organization Settings APIs
Department and Member Management APIs
Unified Member Login APIs
Member Access Management APIs
Organization Service Management APIs
Organization Management Policy APIs
Resource Sharing APIs
Identity Center Management APIs
Identity Center User Management APIs
Identity Center User Group Management APIs
Identity Center Management SCIM Synchronization APIs
Identity Center Single Sign-On Management APIs
Identity Center Permission Configuration Management APIs
Identity Center Multi-Account Authorization Management APIs
Identity Center Sub-User Synchronization Management APIs
Data Types
Error Codes
TCO API 2018-12-25
Tencent Cloud Observability Platform
History
Introduction
API Category
Making API Requests
Monitoring Data Query APIs
Alarm APIs
Legacy Alert APIs
Notification Template APIs
TMP APIs
Grafana Service APIs
Event Center APIs
TencentCloud Managed Service for Prometheus APIs
Monitoring APIs
Data Types
Error Codes
Real User Monitoring
History
Introduction
API Category
Making API Requests
Console APIs
Business System and Project Information APIs
Custom Speed Test APIs
Custom Event APIs
API Monitoring APIs
Exception Analysis APIs
Page View APIs
Static Resource Monitoring APIs
Log APIs
Page Performance APIs
Data Types
Error Codes
International Partners
History
Introduction
API Category
Making API Requests
Customer Management APIs
Credit Management APIs
Agent APIs
Bill Management APIs
Voucher Management APIs
Commission Management APIs
Data Types
Error Codes
Billing Center
API Category
Funds Management APIs
Order Management APIs
Resource Management APIs
Bill Management APIs
Cost Allocation Management APIs
Cost Management APIs
Making API Requests
Organization Account APIs
Data Types
Error Codes
TDSQL Boundless
History
Introduction
API Category
Making API Requests
Instance APIs
Security Group APIs
Task APIs
Backup APIs
Rollback APIs
Parameter APIs
Database APIs
Data Types
Error Codes
TDMQ for MQTT
History
Introduction
API Category
Making API Requests
Cluster APIs
Topic APIs
Authorization Policy APIs
User APIs
Client APIs
Message APIs
Message Enhancement Rule APIs
Data Types
Error Codes
Tencent HY
History
Introduction
API Category
Making API Requests
Hunyuan Text APIs
Hunyuan 3D APIs
Data Types
Error Codes
Smart Media Hosting
History
Introduction
API Category
Making API Requests
PaaS Service APIs
Official Cloud Disk APIs
Data Types
Error Codes
Quota Center
History
Introduction
API Category
Making API Requests
Alarm APIs
Data Types
Error Codes
Message Center
History
Introduction
API Category
Making API Requests
Message Subscription APIs
Data Types
Error Codes
Business Intelligence
History
Introduction
API Category
Making API Requests
Project Management APIs
Role APIs
Database Table APIs
Report Embedding APIs
Page Management APIs
Data Types
Error Codes
LLM Knowledge Engine Basic API
History
Introduction
API Category
Making API Requests
Atomic Capability APIs
Data Types
Error Codes
Tencent Cloud Agent Development Platform
History
API Category
Making API Requests
Atomic Capability APIs
Operation Optimization APIs
Document Library APIs
Q&A Database APIs
Knowledge Tag APIs
Application Management APIs
Enterprise Management APIs
Billing APIs
Release Management APIs
Dialogue Endpoint APIs
Data Statistics APIs
Data Types
Error Codes
Tencent Cloud Blockchain as a Service
History
Introduction
API Category
Making API Requests
Hyperledger Fabric 2.3 APIs
Data Types
Error Codes
Performance Testing Service
History
Introduction
API Category
Making API Requests
PTS-related APIs
Data Types
Error Codes
Real-time Teleoperation
History
Introduction
API Category
Making API Requests
Project APIs
Device APIs
Session APIs
Authorization APIs
Other APIs
Data Types
Error Codes
Gateway Load Balancer
History
Introduction
API Category
Making API Requests
Target Group APIs
GWLB APIs
Other APIs
Data Types
Error Codes
Identity Aware Platform
History
Introduction
API Category
Making API Requests
IAP APIs
Error Codes
Cloud Dedicated Cluster
History
Introduction
API Category
Making API Requests
Cloud Dedicated Cluster (CDC) APIs
Data Types
Error Codes
Image Creation Large Model
History
Introduction
API Category
Making API Requests
Image Style Transfer APIs
Data Types
Error Codes
Face Fusion
API Category
Making API Requests
Image Face Fusion (Basic) APIs
Video Face Fusion (Single Face) APIs
Data Types
Error Codes
Tencent Smart Advisor-Chaotic Fault Generator
History
Introduction
API Category
Making API Requests
Task APIs
Template Library APIs
Data Types
Error Codes
Tencent HealthCare Omics Platform
History
Introduction
API Category
Making API Requests
Environment Management APIs
Tencent Healthcare Omics Platform APIs
Data Types
Error Codes
Tencent Cloud TCHouse-D
History
Introduction
API Category
Making API Requests
Cluster Operation APIs
Database and Table APIs
Cluster Information Viewing APIs
Hot-Cold Data Layering APIs
Database and Operation Audit APIs
User and Permission APIs
Resource Group Management APIs
Data Types
Error Codes
Tencent Cloud WeData
History
Introduction
API Category
Making API Requests
Project Management APIs
Smart Ops Related Interfaces
Resource Group APIs
Data Development APIs
Data Asset - Data Dictionary APIs
Data Development APIs
Ops Center APIs
Data Exploration APIs
Data Operations Related Interfaces
Asset APIs
Metadata Related Interfaces
Task Operations APIs
Data Security APIs
Instance Operation and Maintenance Related Interfaces
Data Map and Data Dictionary APIs
Data Quality Related Interfaces
DataInLong APIs
Platform Management APIs
Data Source Management APIs
Data Quality APIs
Platform Management APIs
Asset Data APIs
Data Source Management APIs
Data Types
Error Codes
WeData API 2025-08-06
Anti-DDoS
History
Introduction
API Category
Making API Requests
Anti-DDoS Advanced Instance APIs
Resource List APIs
Protection Configuration APIs
Other APIs
Alarm Notification APIs
Connection Configuration APIs
Intelligent Scheduling APIs
Black hole unblocking APIs
Statistical Report APIs
Data Types
Error Codes
Cloud Contact Center
History
Introduction
API Category
Making API Requests
Agent APIs
Skill Group APIs
Number APIs
Dual Call APIs
Predictive Outbound Call APIs
SIP Phone APIs
Call Service Record APIs
Billing APIs
Other APIs
Outbound Call APIs
Speech Intelligent Agent APIs
Data Types
Error Codes
Tencent Cloud Super App as a Service
History
Introduction
API Category
Making API Requests
Operation Management APIs
Platform Management APIs
Sensitive API-Related APIs
Role Management APIs
Team Management APIs
Other Console APIs
Mini Program or Mini Game APIs
Management-Sensitive APIs
Global Domain Management APIs
Superapp APIs
User Management APIs
Data Types
Tencent Cloud Smart Advisor
History
Introduction
API Category
Making API Requests
Other APIs
Task APIs
Cloud Architecture Console APIs
Data Types
Error Codes
TDMQ for RabbitMQ
History
Introduction
API Category
Making API Requests
Relevant APIs for RabbitMQ Serverless PAAS Capacity
RabbitMQ Serverless Instance Management APIs
Data Types
Error Codes
Control Center
History
Introduction
API Category
Making API Requests
Account Factory APIs
Data Types
Error Codes
TDMQ for CMQ
API Documentation
API 2.0 to 3.0 Switch Guide
Tencent Cloud TCHouse-P
History
Introduction
API Category
Making API Requests
Information Query APIs
Instance APIs
Query APIs
Cluster Management APIs
Cluster Operation APIs
Data Types
Error Codes
TDMQ for RocketMQ
History
API Category
Making API Requests
Topic APIs
Consumer Group APIs
Message APIs
Role Authentication APIs
Hitless Migration APIs
Cloud Migration APIs
Cluster APIs
Data Types
Error Codes
Cloud Dedicated Zone
History
Introduction
API Category
Making API Requests
Availability Zone APIs
Data Types
Error Codes
Tencent Cloud Health Dashboard
History
Introduction
API Category
Making API Requests
Event APIs
Data Types
Error Codes
Application Performance Management
History
Introduction
API Category
Making API Requests
Application APIs
Business System APIs
General Query APIs
Unavailable APIs
Performance Analysis APIs
Data Types
Error Codes
Config
History
Introduction
API Category
Making API Requests
Rule APIs
Resource APIs
Data Types
Error Codes
Automatic Speech Recognition
History
Introduction
API Category
Making API Requests
Recording Recognition APIs
Real-Time Speech Recognition APIs
Data Types
Error Codes
Tencent Cloud TI Platform
History
Introduction
API Category
Making API Requests
Online Service APIs
Data Types
Error Codes
Web Application Firewall
History
Introduction
API Category
Making API Requests
Asset Management APIs
Billing APIs
Protection Settings APIs
Other APIs
IP Management APIs
Integration APIs
Log Service APIs
Security Overview APIs
Rule Engine APIs
Data Types
Error Codes
Cloud Security Center
History
Introduction
API Category
Making API Requests
Multi-account management related APIs
Scan Task APIs
Risk Center APIs
Asset Center APIs
Cloud Boundary Analysis APIs
Cloud API Anomaly Detection APIs
Report Download APIs
Solid Protection APIs
Cloud Security Center Overview APIs
Data Types
Error Codes
Risk Control Engine
History
Introduction
API Category
Making API Requests
TencentCloud API APIs
Data Types
Error Codes
TencentDB for CTSDB
History
Introduction
API Category
Making API Requests
Instance APIs
Database APIs
Data Types
Error Codes
Tencent Interactive Whiteboard
History
Introduction
API Category
Making API Requests
Whiteboard Push APIs
Other APIs
Document Transcoding APIs
Real-Time Recording APIs
Statistics Query APIs
Whiteboard Snapshot APIs
Recording Video Generation APIs
Data Types
Error Codes
Tencent Container Security Service
History
Introduction
API Category
Making API Requests
Network Security APIs
Cluster Security APIs
Security Compliance APIs
Runtime security - High-risk syscalls
Runtime Security - Reverse Shell APIs
Runtime Security APIs
Alert Settings APIs
Advanced prevention - K8s API abnormal requests
Asset Management APIs
Security Operations - Log Analysis APIs
Runtime Security - Trojan Call APIs
Runtime Security - Container Escape APIs
Image Security APIs
Billing APIs
Data Types
Error Codes
Domains
History
Introduction
API Category
Making API Requests
Domain Management APIs
Domain Query APIs
Bulk Operation APIs
Registrant Profile APIs
Other APIs
Data Types
Error Codes
Low-code Interactive Classroom
History
Introduction
API Category
Making API Requests
User Login APIs
Room Management APIs
Group Management APIs
Application Configuration APIs
Recording Management APIs
Courseware Management APIs
User Management APIs
Developer APIs
Data Types
Error Codes
문서APIsTencent Cloud Agent Development PlatformData Types

Data Types

포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-03-26 22:26:47

AICallConfig

Smart Conversation

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
EnableVoiceInteract Boolean No Enable voice interaction feature
EnableVoiceCall Boolean No Enable voice call
EnableDigitalHuman Boolean No Enable digital human
Voice VoiceConfig No Timbre Configuration
DigitalHuman DigitalHumanConfig No Digital Human Configuration

AgentDebugInfo

Agent Debugging Information

Used by actions: GetMsgRecord.

Name Type Required Description
Input String No Input Information for Tools and Large Models, json
Output String No Output Information for Tools and Large Models, json

AgentProcedure

Process information of the thought event.

Used by actions: GetMsgRecord.

Name Type Required Description
Index Integer No Index.
Name String No English name of the execution process.
Title String No Chinese name for display.
Status String No Status constant: processing; success; failed.
Icon String No Icon.
Debugging AgentProcedureDebugging No Agent debugging information.
Switch String No Whether to switch to Agent. The value can be "main" or "workflow". Leave it blank for no switch.
WorkflowName String No Workflow name.
Elapsed Integer No Current request execution time, in milliseconds.
NodeName String No Workflow node name.
ReplyIndex Integer No Used to display in which reply bubble the thoughts are placed.
SourceAgentName String No Main agent.
TargetAgentName String No Registration agent.
AgentIcon String No Icon of Agent.

AgentProcedureDebugging

Debugging information of the agent thinking process.

Used by actions: GetMsgRecord.

Name Type Required Description
Content String No Model thinking content.
DisplayContent String No The specific text content to be displayed.
DisplayType Integer No Display type.
QuoteInfos Array of QuoteInfo No Index displayed by the search engine.
References Array of AgentReference No Specific reference source.
DisplayStatus String No Display the ongoing status.
SandboxUrl String No URL of cloud desktop.
DisplayUrl String No URL opened through the browser in cloud desktop.

AgentReference

Reference source in agent.

Used by actions: GetMsgRecord.

Name Type Required Description
DocId String No Source document ID.
Id String No ID.
Name String No Name.
Type Integer No Type.
Url String No URL.
DocBizId String No Document business ID.
DocName String No Document name.
QaBizId String No Q&A business ID.
Index Integer No Index of search engine.
Title String No Title.

AgentThought

The thinking process of Agent.

Used by actions: GetMsgRecord.

Name Type Description
SessionId String Session ID.
RequestId String Request ID
RecordId String It corresponds to a session, session ID, used for message storage in answering. It can be generated in advance and used when saving messages.
Elapsed Integer Current request execution time, in milliseconds.
IsWorkflow Boolean Whether it is a workflow currently.
WorkflowName String If it is a workflow, workflow name.
Procedures Array of AgentProcedure Detailed thinking process.
TraceId String TraceId.
Files Array of FileInfo File information

ApiVarAttrInfo

Data of custom variable and label relationship.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
ApiVarId String No Custom variable ID.
AttrBizId String No Label ID.

AppConfig

Application configuration.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
KnowledgeQa KnowledgeQaConfig No Knowledge Q&A management application configuration
Summary SummaryConfig No Knowledge summary application configuration.
Classify ClassifyConfig No Label extraction application configuration.

AppInfo

Application details

Used by actions: ListApp.

Name Type Required Description
AppType String No Application type; knowledge_qa - knowledge Q&A management; summary - knowledge summary; classifys - knowledge label extraction.
AppTypeDesc String No Application type description.
AppBizId String No Application ID.
Name String No Application name.
Avatar String No Application avatar.
Desc String No Application description.
AppStatus Integer No Application status. 1: offline; 2: running; 3: disabled.
AppStatusDesc String No Status description.
UpdateTime String No Update time.
Operator String No Last modifier.
ModelName String No Model name.
ModelAliasName String No Alias of the generative model.
Pattern String No Application mode: standard; agent; single_workflow.
ThoughtModelAliasName String No Alias of the thought model.

AppModel

Application model configuration.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Name String No Model name.
Desc String No Model description.
ContextLimit Integer No The round referenced by the context.
AliasName String No Model alias.
TokenBalance Float No Remaining token quota.
IsUseContext Boolean No Whether to use the round referenced by the context.
HistoryLimit Integer No The number of context memory rounds.
UsageType String No Usage type.
Temperature String No Model temperature.
TopP String No Model TopP.
ResourceStatus Integer No Model resource status: 1: available; 2: exhausted.

AttrLabel

Label details.

Used by actions: DescribeDoc, DescribeQA, ListDoc, ListQA.

Name Type Description
Source Integer Label source.
AttrBizId String Label ID.
AttrKey String Label identification.
AttrName String Label name.
Labels Array of Label Label value.

AttrLabelDetail

Label details.

Used by actions: ListAttributeLabel.

Name Type Description
AttrBizId String Label ID.
AttrKey String Label identification.
AttrName String Label name.
LabelNames Array of String Label value name.
IsUpdating Boolean Whether the label is being updated.
Status Integer Status.
StatusDesc String Status description.
LabelTotalCount String Total number of label values.

AttrLabelRefer

Label reference information.

Used by actions: CreateQA, ModifyDoc, ModifyDocAttrRange, ModifyQA, ModifyQAAttrRange, SaveDoc.

Name Type Required Description
Source Integer No Label source, 1: label.
AttributeBizId String No Label ID.
LabelBizIds Array of String No Label value ID.

AttributeFilters

Export knowledge label filter.

Used by actions: ExportAttributeLabel.

Name Type Required Description
Query String No Retrieve, attribute or label name.

AttributeLabel

Label value.

Used by actions: CreateAttributeLabel, DescribeAttributeLabel, ModifyAttributeLabel.

Name Type Required Description
LabelBizId String No Standard word ID.
LabelName String No Standard word name.
SimilarLabels Array of String No Synonym name.

BaseConfig

Application basic configuration.

Used by actions: CreateApp, DescribeApp, ModifyApp.

Name Type Required Description
Name String Yes Application name.
Avatar String Yes Application avatar url, required as an input parameter in "CreateApp" and "ModifyApp". Description of input parameter: 1. The image of input URL must be jpeg or png, with a size no more than 500kb, and the URL must allow head requests. 2. If the user does not have object storage, use the "Obtain temporary file upload key" (DescribeStorageCredential) API to obtain the COS temporary key and upload path. Upload the avatar to COS by yourself and get the access link.
Desc String No Application description.

CallDetail

Call type.

Used by actions: ListUsageCallDetail.

Name Type Description
Id String Associated ID.
CallTime String Call time.
TotalTokenUsage Float Total token consumption.
InputTokenUsage Float Token consumption for input.
OutputTokenUsage Float Token consumption for output.
SearchUsage Integer Number of search service calls.
ModelName String Model name.
CallType String Call type.
UinAccount String Account.
AppName String Application name.
PageUsage Integer Total number of consumed pages.
SubScene String Filter sub-scenario.

CateInfo

Category information.

Used by actions: ListDocCate.

Name Type Description
CateBizId String Category ID.
Name String Category name.
Total Integer Quantity of records (such as documents, synonyms, etc.) under the category.
CanAdd Boolean Whether it is possible to add.
CanEdit Boolean Whether it can be edited.
CanDelete Boolean Whether it can be deleted.
Children Array of CateInfo Subcategory.

ClassifyConfig

Label extraction configuration.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Model AppModel No Model configuration.
Labels Array of ClassifyLabel No Label list.
Greeting String No Welcome words, within 200 characters.

ClassifyLabel

Label information.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Name String No Label name.
Description String No Label description.
Values Array of String No Label value range.

Context

Obtain response of unsatisfied reply context.

Used by actions: DescribeUnsatisfiedReplyContext.

Name Type Description
RecordBizId String Message record ID.
IsVisitor Boolean Whether it is a user.
NickName String Nickname.
Avatar String Avatar.
Content String Message content.
FileInfos Array of MsgFileInfo Document information.
ReplyMethod Integer Response method, 15: clarification confirmation response.

CreateReconstructDocumentFlowConfig

Configuration information for creating a smart document parsing task.

Used by actions: CreateReconstructDocumentFlow.

Name Type Required Description
TableResultType String No The returned form of a table in a markdown file:
0: the table is returned in MD format;
1: the table is returned in HTML form.
The default is 1.
ResultType String No The format of smart document parsing results:
0: only return full-text MD;
1: only return OCR original JSON of each page;.
2: only return MD of each page;
3: return full-text MD + OCR original JSON of each page;.
4: return full-text MD + MD of each page.
The default value is 3 (return full-text MD + OCR original JSON of each page).

Credentials

Temporary key structure.

Used by actions: DescribeStorageCredential.

Name Type Description
Token String Token.
TmpSecretId String Temporary license key ID.
TmpSecretKey String Temporary license key.
AppId Integer Temporary license appid.

DigitalHumanConfig

Digital Human Configuration

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
AssetKey String No Digital Human Asset key
Name String No Digital Human Name
Avatar String No Image

DocFilterFlag

Document list filter flag

Used by actions: ListDoc.

Name Type Required Description
Flag String No Flag
Value Boolean No ID Value

DocSegment

Document fragment.

Used by actions: DescribeSegments.

Name Type Description
Id String Fragment ID.
BusinessId String Business ID.
FileType String File type (markdown, word, txt).
SegmentType String Document segment type (segment, table).
Title String Title.
PageContent String Paragraph content.
OrgData String Original paragraph.
DocId String Article ID.
DocBizId String Document business ID.
DocUrl String Document URL.

DuplicateFileHandle

Duplicate document handling method

Used by actions: SaveDoc.

Name Type Required Description
CheckType Integer No Duplicate document identification method, 1: By document content, i.e., using the cos_hash field to determine whether duplicates exist
HandleType Integer No Duplicate document handling method, 1: Return an error, 2: Skip and return the business ID of the duplicate document

ExtraInfo

Extended Information

Used by actions: GetMsgRecord.

Name Type Required Description
EChartsInfo Array of String No ECharts Information

FileInfo

Real-Time uploaded file information.

Used by actions: GetMsgRecord.

Name Type Description
FileName String File name.
FileSize String File size.
FileUrl String URL of the file, address of COS.
FileType String File type.
DocId String DocID returned after parsing.
CreatedAt String Creation time.

Filters

Retrieve and filter dissatisfied responses.

Used by actions: ExportUnsatisfiedReply.

Name Type Required Description
Query String No Retrieve user question or answer.
Reasons Array of String No Incorrect retrieval type.

GetWsTokenReq_Label

Obtain ws token label.

Used by actions: GetWsToken.

Name Type Required Description
Name String No Label name.
Values Array of String No Label value.

Highlight

Fragment highlight content.

Used by actions: DescribeQA, DescribeRefer.

Name Type Required Description
StartPos String No Highlight starting position.
EndPos String No Highlight end position.
Text String No Highlight subtext.

HistorySummary

Multiple rounds of historical information.

Used by actions: GetMsgRecord.

Name Type Required Description
Assistant String No Assistant.
User String No User.

IntentAchievement

Intent Implementation Approach

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Name String No Intent Implementation Approach, qa: Q&A response, doc: document-based response, workflow: workflow-based response, llm: LLM response
Desc String No Intent Implementation Approach Description

InvokeAPI

Information of the requested API.

Used by actions: GetMsgRecord.

Name Type Required Description
Method String No Request method, such as get/post.
Url String No Request address.
HeaderValues Array of StrValue No Header parameter.
QueryValues Array of StrValue No Input parameter Query.
RequestPostBody String No Original data of a Post request.
ResponseBody String No Returned original data.
ResponseValues Array of ValueInfo No Output parameter.
FailMessage String No Exception information.

KnowledgeCapacityPieGraphDetail

Detailed information of a knowledge library capacity pie chart.

Used by actions: DescribeKnowledgeUsagePieGraph.

Name Type Description
AppName String Current application name.
UsedCharSize String Number of characters used by the current application.
Proportion Float Proportion of the current application in total usage.

KnowledgeDetail

Application usage details of knowledge library capacity.

Used by actions: ListAppKnowledgeDetail.

Name Type Required Description
AppName String No Application name.
UsedCharSize String No Number of used characters.
Proportion Float No Usage proportion.
ExceedCharSize String No Exceeding character count.

KnowledgeQaConfig

Knowledge Q&A configuration.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Greeting String No Welcome words, within 200 characters.
RoleDescription String No Character description, within 4,000 characters. By filling out the description, set the #Character Name, #Style Characteristics, and reachable #Intent of the application. It is recommended to fill in according to the following template, with custom intents no more than 5.
#Character Name:
#Style Characteristics:
#Output Requirements:
#Ability Limitations:
The following user intents can be reached.
##Intent Name:
##Intent Description:
##Intent Example:
##Intent Implementation:
Model AppModel No Generative model configuration.
Search Array of KnowledgeQaSearch No Knowledge search configuration.
Output KnowledgeQaOutput No Knowledge management output configuration.
Workflow KnowledgeWorkflow No Workflow configuration.
SearchRange SearchRange No Retrieval range.
Pattern String No Application modes: standard, agent, single_workflow.
SearchStrategy SearchStrategy No Retrieve a policy.
SingleWorkflow KnowledgeQaSingleWorkflow No Single workflow ID, which is entered when Pattern is single_workflow.
Plugins Array of KnowledgeQaPlugin No Application associated plug-in.
ThoughtModel AppModel No Thinking model configuration.
IntentAchievements Array of IntentAchievement No Priority of intent achievement methods.
ImageTextRetrieval Boolean No Whether to enable Image-Text Search.
AiCall AICallConfig No Configure voice call parameters.
EnableAudit Boolean No Session content moderation switch. Note: 1. This feature is enabled by default if no value is input. 2. Tencent Cloud provides a content pre-filtering feature to help filter high-risk or illegal content. If you do not use our filtering feature, you can disable it here. We hereby remind you that you are responsible for ensuring that your content complies with platform policies and laws and regulations, and that you should fulfill your content moderation obligations.

KnowledgeQaOutput

Application management output configuration.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Method Integer No Output method, 1: streaming 2: non-streaming.
UseGeneralKnowledge Boolean No General model response.
BareAnswer String No Unknown response, within 300 characters.
ShowQuestionClarify Boolean No Whether to display the question clarification switch.
UseQuestionClarify Boolean No Whether to enable question clarification.
QuestionClarifyKeywords Array of String No List of keywords for question clarification.
UseRecommended Boolean No Whether to enable recommended questions.

KnowledgeQaPlugin

Information of application-associated plug-in.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
PluginId String No Plugin ID.
PluginName String No Plugin name.
PluginIcon String No Plugin icon.
ToolId String No Tool ID.
ToolName String No Tool name.
ToolDesc String No Tool description.
Inputs Array of PluginToolReqParam No Tool input parameter.
IsBindingKnowledge Boolean No Whether the plugin is bound to the knowledge library.

KnowledgeQaSearch

Retrieval configuration.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Type String No Knowledge source: doc (document), qa (question & answering), taskflow (business process), search (search enhancement).
ReplyFlexibility Integer No Q&A - reply flexibility, 1: directly reply if the answer has been accepted. 2: reply after the accepted answer has been polished.
UseSearchEngine Boolean No Search enhancement - search engine status.
ShowSearchEngine Boolean No Whether to display the search engine retrieval status.
IsEnabled Boolean No Knowledge source, whether to select.
QaTopN Integer No Maximum number of Q&A recalls, defaults to 2, limited to 5.
DocTopN Integer No Maximum number of documents recalls, defaults to 3, limited to 5.
Confidence Float No Retrieval confidence degree, valid for documents and Q&A. Value range: 0.01 - 0.99.
ResourceStatus Integer No Resource status, 1: the resource is available; 2: the resource is exhausted.

KnowledgeQaSingleWorkflow

Specifies the single workflow configuration in Q&A knowledge library single workflow mode.

Used by actions: DescribeApp, GetWsToken, ModifyApp.

Name Type Required Description
WorkflowId String No Workflow ID.
WorkflowName String No Workflow name.
WorkflowDesc String No Workflow description.
Status String No Workflow status, publishing status (UNPUBLISHED; PUBLISHING; PUBLISHED; FAIL).
IsEnable Boolean No Whether to enable workflow.
AsyncWorkflow Boolean No Whether to enable asynchronous call of the workflow.

KnowledgeSummary

Retrieve knowledge.

Used by actions: GetMsgRecord.

Name Type Required Description
Type Integer No 1: Q&A; 2: document fragment.
Content String No Knowledge content.

KnowledgeWorkflow

Q&A knowledge library workflow configuration.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
IsEnabled Boolean No Whether to enable the workflow.
UsePdl Boolean No Whether to enable PDL.

Label

Label ID.

Used by actions: DescribeDoc, DescribeQA.

Name Type Description
LabelBizId String Label ID.
LabelName String Label name.

ListAppCategoryRspOption

Application type details.

Used by actions: ListAppCategory.

Name Type Description
Text String Type name.
Value String Type value.
Logo String Type log.

ListDocItem

Description of document list details.

Used by actions: ListDoc.

Name Type Description
DocBizId String Document ID.
FileName String File name.
NewName String The new document name after renaming. This name remains until the document is published after the renaming submission.
FileType String File type.
CosUrl String COS path.
UpdateTime String Update time.
Status Integer Document status.
StatusDesc String Document status description.
Reason String Reason.
IsRefer Boolean Whether to refer to an answer.
QaNum Integer Quantity of Q&A pairs.
IsDeleted Boolean Whether it has been deleted.
Source Integer Document source.
SourceDesc String Document source description.
IsAllowRestart Boolean Whether regeneration is allowed.
IsDeletedQa Boolean Whether the Q&A has been deleted.
IsCreatingQa Boolean Whether the Q&A is being generated.
IsAllowDelete Boolean Whether deletion is allowed.
IsAllowRefer Boolean Whether to allow operation reference switch.
IsCreatedQa Boolean Whether Q&A has been generated.
DocCharSize String Document character count.
AttrRange Integer Applicable range of attribute label.
AttrLabels Array of AttrLabel Attribute label.
IsAllowEdit Boolean Whether editing is allowed.
ReferUrlType Integer External reference URL type, 0: system URL; 1: custom URL.
When the value is 1, the WebUrl field cannot be empty; otherwise, it will not take effect.
WebUrl String Web page URL (or custom URL) .
ExpireStart String Effective start time, unix timestamp.
ExpireEnd String Effective end time, unix timestamp. 0 indicates permanent validity.
IsAllowRetry Boolean Whether retries are allowed, 0: no, 1: yes.
Processing Array of Integer 0: document comparison processing; 1: Q&A generation from document.
CreateTime String Time when the document was created and stored into the database.
CateBizId String ID of the document's category.
CustomerKnowledgeId String User-defined ID of the document.
AttributeFlags Array of Integer Attribute label of the document. 0: Do not perform external user permission verification.

ListQaItem

Q&A details data.

Used by actions: ListQA.

Name Type Description
QaBizId String Q&A ID.
Question String Question.
Answer String Answer.
Source Integer Source.
SourceDesc String Source description.
UpdateTime String Update time.
Status Integer Status.
StatusDesc String Status description.
DocBizId String Document ID.
CreateTime String Creation time.
IsAllowEdit Boolean Whether editing is allowed.
IsAllowDelete Boolean Whether deletion is allowed.
IsAllowAccept Boolean Whether verification is allowed.
FileName String Document name.
FileType String Document type.
QaCharSize String Number of Q&A characters.
ExpireStart String Effective start time, unix timestamp.
ExpireEnd String Effective end time, unix timestamp. 0 indicates permanent validity.
AttrRange Integer Applicable range of attribute label, 1: all, 2: by conditions.
AttrLabels Array of AttrLabel Attribute label.
SimilarQuestionNum Integer Count of similar questions.
SimilarQuestionTips String Return similar questions associated with the Q&A and perform linked search. Only one similar question will be displayed.

ListReleaseItem

Details of release list.

Used by actions: ListRelease.

Name Type Description
ReleaseBizId String Version ID.
Operator String Releaser.
Desc String Release description.
UpdateTime String Update time.
Status Integer Release status.
StatusDesc String Release status description.
Reason String Reason for failure.
SuccessCount Integer Number of successful releases.
FailCount Integer Number of failed releases.

ModelInfo

Model information.

Used by actions: ListModel.

Name Type Required Description
ModelName String No Model name.
ModelDesc String No Model description.
AliasName String No Model name.
ResourceStatus Integer No Resource status, 1: available; 2: exhausted.
PromptWordsLimit String No Character limit of prompt content.
TopP ModelParameter No By controlling the diversity of content generation through core sampling, a higher Top P value will lead to more diverse content generation.
Temperature ModelParameter No Temperature control randomness.
MaxTokens ModelParameter No Maximum quantity of tokens that can be generated.
Source String No Model source, Hunyuan: Tencent Hunyuan; Industry: Tencent Cloud industry large model; Experience: new model experience.
Icon String No Model icon.
IsFree Boolean No Whether it is free.
InputLenLimit Integer No Maximum characters input in the model dialog box.
SupportWorkflowStatus Integer No Workflow support levels:
0 - Not supported by the model;
1 - Supported by the model;
2 - Poorly supported by the model.
ModelCategory String No Model categories:
Generate: Generative model
Thought: Thinking model
IsDefault Boolean No Whether it is the default model.
RoleLenLimit Integer No Maximum characters of role prompt words.
IsExclusive Boolean No Whether it is an exclusive concurrency model.
SupportAiCallStatus Integer No The model supports intelligent call effects.

ModelParameter

Model parameter value range.

Used by actions: ListModel.

Name Type Required Description
Default Float No Default value.
Min Float No Minimum value.
Max Float No Maximum value.

MsgFileInfo

Document information.

Used by actions: DescribeUnsatisfiedReplyContext.

Name Type Description
FileName String Document name.
FileSize String Document size.
FileUrl String Document URL.
FileType String Document type.
DocId String Document ID.

MsgRecord

Message details.

Used by actions: GetMsgRecord.

Name Type Description
Content String Content.
SessionId String The Session ID corresponding to the current record.
RecordId String Record ID.
RelatedRecordId String Associated record ID.
IsFromSelf Boolean Whether it is from oneself.
FromName String Sender name.
FromAvatar String Avatar of the sender.
Timestamp String Timestamp.
HasRead Boolean Whether it is read.
Score Integer Evaluation.
CanRating Boolean Whether to rate.
CanFeedback Boolean Whether to display the feedback button.
Type Integer Record type.
References Array of MsgRecordReference Reference source.
Reasons Array of String Reason for evaluation.
IsLlmGenerated Boolean Whether it is a large model.
ImageUrls Array of String Image URL, which can be public read.
TokenStat TokenStat Statistical information of the current token.
ReplyMethod Integer Response method.
1: Large model directly replies.
2: Conservative reply, reply to unknown questions.
3: Reply to rejected question.
4: Sensitive response.
5: Directly reply to Q&A pairs. Priority will be given to answering the adopted Q&A pairs.
6: Reply with welcome words.
7: Reply for concurrency limit exceeded.
8: Global intervention knowledge.
9: Reply during the task flow process. When task_flow.type = 0 in history, it is a response from the large model.
10: Reply with task flow answer.
11: Reply from the search engine.
12: Reply after knowledge polishing.
13: Reply with image understanding.
14: Reply based on real-time document.
OptionCards Array of String Option tab, used for multi-round dialogue.
TaskFlow TaskFlowInfo Task information.
FileInfos Array of FileInfo File information passed in by the user.
QuoteInfos Array of QuoteInfo Location information of reference source .
AgentThought AgentThought Information on the thinking process of the agent.
ExtraInfo ExtraInfo Expanded information.
WorkFlow WorkflowInfo Workflow information.

MsgRecordReference

Chat details Refer.

Used by actions: GetMsgRecord.

Name Type Description
Id String ID
Url String URL.
Type Integer Type.
Name String Name.
DocId String Source document ID.

Option

Dropdown options.

Used by actions: ListSelectDoc.

Name Type Required Description
Text String No Text.
Value String No Value.
CharSize String No Number of characters in a file.
FileType String No File type.

PluginToolReqParam

Plugin parameter request structure.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Name String No Parameter name.
Desc String No Parameter description.
Type Integer No Parameter type, 0: string; 1: int; 2: float; 3: bool; 4: object; 5: array_string; 6: array_int; 7: array_float; 8: array_bool; 9: array_object, 99: null, 100: upspecified.
IsRequired Boolean No Whether the parameter is required.
DefaultValue String No Parameter default value.
SubParams Array of PluginToolReqParam No Sub-parameter. "ParamType" is useful when it is "OBJECT " or "ARRAY<>" type.
GlobalHidden Boolean No Whether the plugin parameter configuration is hidden and invisible. true - Hidden and invisible; false - Visible.
OneOf Array of PluginToolReqParam No OneOf type parameter.
AnyOf Array of PluginToolReqParam No AnyOf type parameter.

Procedure

Execution process information log.

Used by actions: GetMsgRecord.

Name Type Required Description
Name String No English name of execution process.
Title String No Chinese name for display.
Status String No Status: processing, success, failed.
Count Integer No Number of consumed tokens.
Debugging ProcedureDebugging No Debugging information.
ResourceStatus Integer No Billing resource status, 1: available; 2: unavailable.

ProcedureDebugging

Debug information.

Used by actions: GetMsgRecord.

Name Type Required Description
Content String No Retrieve query.
System String No System prompt.
Histories Array of HistorySummary No Multiple rounds of historical information.
Knowledge Array of KnowledgeSummary No Retrieve knowledge.
TaskFlow TaskFlowSummary No Task process.
WorkFlow WorkFlowSummary No Workflow debugging information.
Agent AgentDebugInfo No Agent debugging information.
CustomVariables Array of String No Custom parameter.

QACate

Obtain Q&A category group.

Used by actions: ListQACate.

Name Type Description
CateBizId String Q&A category business ID.
Name String Category name.
Total Integer Quantity of Q&As under the category.
CanAdd Boolean Whether it is possible to add.
CanEdit Boolean Whether it can be edited.
CanDelete Boolean Whether it can be deleted.
Children Array of QACate Subcategory.

QAList

Q&A list.

Used by actions: VerifyQA.

Name Type Required Description
QaBizId String Yes Q&A ID.
IsAccepted Boolean No Whether to accept.
CateBizId String No Category ID.
Question String No Question.
Answer String No Answer.

QAQuery

Q&A query parameter.

Used by actions: ExportQAList.

Name Type Required Description
PageNumber Integer Yes Page number.
PageSize Integer Yes Number of items per page.
BotBizId String Yes Application ID.
Query String No Query content.
CateBizId String No Category ID.
AcceptStatus Array of Integer No Verification status.
ReleaseStatus Array of Integer No Release status.
DocBizId String No Document ID.
QaBizId String No Q&A ID.
Source Integer No Source.
QueryAnswer String No Query an answer.
QueryType String No Query type: filename, attribute label.

QuoteInfo

Search engine reference source index.

Used by actions: GetMsgRecord.

Name Type Required Description
Position Integer No Reference source location.
Index String No Reference source index sequence.

ReconstructDocumentFailedPage

Document parsing failure record.

Used by actions: GetReconstructDocumentResult.

Name Type Description
PageNumber Integer Failure page number.

ReferDetail

Reference source details.

Used by actions: DescribeRefer.

Name Type Description
ReferBizId String Reference ID.
DocType Integer Document type (1: Q&A; 2: document paragraph).
DocName String Document name.
PageContent String Fragment content.
Question String Question.
Answer String Answer.
Confidence Float Confidence.
Mark Integer Mark.
Highlights Array of Highlight Fragment highlight content.
OrgData String Original content.
PageInfos Array of Integer Page number information.
SheetInfos Array of String Sheet information.
DocBizId String Document ID.

RejectedQuestion

Release rejected questions.

Used by actions: ListRejectedQuestion.

Name Type Description
RejectedBizId String Reject question ID.
Question String The question that has been rejected.
Status Integer Status.
StatusDesc String Status description.
UpdateTime String Update time.
IsAllowEdit Boolean Whether editing is allowed.
IsAllowDelete Boolean Whether deletion is allowed.

ReleaseConfigs

Release configuration items.

Used by actions: ListReleaseConfigPreview.

Name Type Description
ConfigItem String Configuration item description.
UpdateTime String Update time.
Action Integer Status.
Value String Content after modification.
LastValue String Content before modification.
Content String Modified content (display "content" with priority. If "content" is empty, take "value").
Message String Reason for failure.

ReleaseDoc

Release document details.

Used by actions: ListReleaseDocPreview.

Name Type Required Description
FileName String No File name.
FileType String No File type.
UpdateTime String No Update time.
Action Integer No Status.
ActionDesc String No Status description.
Message String No Reason for failure.
DocBizId String No Document business ID.

ReleaseQA

Release Q&A.

Used by actions: ListReleaseQAPreview.

Name Type Required Description
Question String No Question.
UpdateTime String No Update time.
Action Integer No Status.
ActionDesc String No Status description.
Source Integer No Source, 1: documentation generation; 2: batch import; 3: manual addition.
SourceDesc String No Source description.
FileName String No Filename.
FileType String No Document type.
Message String No Reason for failure
ReleaseStatus Integer No Release status.
QaBizId String No Q&A ID.
DocBizId String No Document business ID.

ReleaseRejectedQuestion

Release rejected questions.

Used by actions: ListRejectedQuestionPreview.

Name Type Description
Question String Question.
UpdateTime String Update time.
Action Integer Status.
ActionDesc String Status description.
Message String Reason for failure.

RunNodeInfo

Node information

Used by actions: GetMsgRecord.

Name Type Required Description
NodeType Integer No Node type, 0: unspecified; 1: start node; 2: api node; 3: inquiry node; 4: answer node.
NodeId String No Node ID.
NodeName String No Node name.
InvokeApi InvokeAPI No Requested API.
SlotValues Array of ValueInfo No Values of all slots of the current node, key: SlotID. Return an Null even if there is no value.

SearchRange

Retrieval range configuration.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Condition String No Search criteria and/or.
ApiVarAttrInfos Array of ApiVarAttrInfo No Custom variable and label relational data.

SearchStrategy

Knowledge library retrieval strategy.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
StrategyType Integer No Retrieval strategy type, 0: hybrid retrieval; 1: semantic retrieval.
TableEnhancement Boolean No Excel retrieval enhancement switch.

SimilarQuestion

Similar question information.

Used by actions: DescribeQA, ModifyQA.

Name Type Required Description
SimBizId String No Similar question ID.
Question String No Similar question content.
AuditStatus Integer No Similar question review status, 1: audit failure.

SimilarQuestionModify

Similar question modification (update) information.

Used by actions: ModifyQA.

Name Type Required Description
AddQuestions Array of String No List of similar questions (content) to be added.
UpdateQuestions Array of SimilarQuestion No List of similar questions to be updated.
DeleteQuestions Array of SimilarQuestion No List of similar questions to be deleted.

Stat

Billing statistical information.

Used by actions: DescribeCallStatsGraph, DescribeSearchStatsGraph, DescribeTokenUsageGraph.

Name Type Description
X String X-axis: time zone; return three interval ranges of "minute/hour/day" according to the granularity of the query condition.
Y Float Y-axis: statistical values in this time period, such as token consumption, call count, or usage information.

StatisticInfo

Statistical information of large model tokens.

Used by actions: GetMsgRecord.

Name Type Required Description
ModelName String No Model name.
FirstTokenCost Integer No Time consumption of the first token.
TotalCost Integer No Total time consumption.
InputTokens Integer No Number of input tokens.
OutputTokens Integer No Number of output tokens.
TotalTokens Integer No Total number of tokens.

StrValue

String KV information.

Used by actions: GetMsgRecord.

Name Type Required Description
Name String No Name.
Value String No Value.

SummaryConfig

Knowledge summary application configuration.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Model AppModel No Model configuration.
Output SummaryOutput No Knowledge summary output configuration.
Greeting String No Welcome words, within 200 characters.

SummaryOutput

Knowledge summary output configuration.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Method Integer No Output method: 1. streaming; 2. non-streaming.
Requirement Integer No Output requirement 1: text summary. 2: customized requirement.
RequireCommand String No Custom requirement command.

TaskFlowInfo

Task process information.

Used by actions: GetMsgRecord.

Name Type Description
TaskFlowId String Task flow ID.
TaskFlowName String Task flow name.
QueryRewrite String Rewrite results of query.
HitIntent String Hit intent.
Type Integer Task flow response type.
0: Task flow response.
1: Silent task flow.
2: Pull back script of workflow.
3: Custom response of task flow.

TaskFlowSummary

Task process debugging information.

Used by actions: GetMsgRecord.

Name Type Required Description
IntentName String No Task flow name.
UpdatedSlotValues Array of ValueInfo No Entity list.
RunNodes Array of RunNodeInfo No Node list.
Purposes Array of String No Intent determination.

TaskParams

Task parameter.

Used by actions: GetTaskStatus.

Name Type Description
CosPath String Download address. Download through the COS bucket temporary key.

TokenStat

Current executed token statistical information.

Used by actions: GetMsgRecord.

Name Type Required Description
SessionId String No Session ID.
RequestId String No Request ID.
RecordId String No It corresponds to a session, session id, used for storing messages for answering. It can be generated in advance, used when saving messages.
UsedCount Integer No Number of consumed tokens.
FreeCount Integer No Number of free tokens.
OrderCount Integer No Total number of tokens for orders.
StatusSummary String No Current execution status summary. Constant: processing, success., failed.
StatusSummaryTitle String No Chinese display after summarizing the current execution status.
Elapsed Integer No Current request execution time, in milliseconds.
TokenCount Integer No Number of tokens consumed by the current request.
Procedures Array of Procedure No Execution information.
TraceId String No Execution process information TraceId.

UnsatisfiedReply

Unsatisfied response.

Used by actions: ListUnsatisfiedReply.

Name Type Description
ReplyBizId String Unsatisfied response ID.
RecordBizId String Message record ID.
Question String User question.
Answer String Application response.
Reasons Array of String Error type.

UpdatePeriodInfo

Update Policy

Used by actions: SaveDoc.

Name Type Required Description
UpdatePeriodH Integer No Document update frequency type: 0: No update, -H: Hourly granularity. Currently only supports 24 (1 day), 72 (3 days), 168 (7 days). Only valid for source=2 Tencent document type.

ValueInfo

Task flow parameter information.

Used by actions: GetMsgRecord.

Name Type Required Description
Id String No Value ID.
Name String No Name.
ValueType Integer No Value type, 0: unknown or empty; 1: string; 2: integer; 3: float; 4: boolean; 5: array (string array); 6: object_array (structure array); 7: object (structure).
ValueStr String No String.
ValueInt String No Int (return as a string to avoid precision loss).
ValueFloat Float No Float.
ValueBool Boolean No Bool.
ValueStrArray Array of String No Array.

VoiceConfig

Timbre Parameters

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
VoiceType Integer No Public Cloud Timbre ID
TimbreKey String No Timbre Key
VoiceName String No Timbre Name

WorkFlowSummary

Workflow debugging information.

Used by actions: GetMsgRecord.

Name Type Required Description
WorkflowId String No Workflow ID.
WorkflowName String No Workflow name.
WorkflowRunId String No Workflow running ID.
RunNodes Array of WorkflowRunNodeInfo No Node information.
OptionCards Array of String No Tab.
Outputs Array of String No Output results of multiple bubbles.
WorkflowReleaseTime String No Workflow release time, Unix timestamp.

WorkflowInfo

Workflow Information

Used by actions: GetMsgRecord.

Name Type Required Description
WorkflowId String No Workflow ID
WorkflowName String No Workflow Name
WorkflowRunId String No Workflow Run ID
OptionCards Array of String No Tab
Outputs Array of String No Multi-bubble output results
WorkflowReleaseTime String No Workflow Publish Time, unix timestamp

WorkflowRunNodeInfo

Workflow running node information.

Used by actions: GetMsgRecord.

Name Type Required Description
NodeId String No Node ID.
NodeType Integer No Node type.
NodeName String No Node name.
Status Integer No Status.
Input String No Input..
Output String No Output.
TaskOutput String No Task output.
FailMessage String No Error message.
CostMilliSeconds Integer No Time consumption.
StatisticInfos Array of StatisticInfo No Large model output information.
이전 주제: GetAppKnowledgeCount다음 주제: Error Codes

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백