tencent cloud

Tencent Cloud Agent Development Platform

DokumentasiTencent Cloud Agent Development Platform

Data Types

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-11-04 21:51:14

AICallConfig

Intelligent Call Configuration

Used by actions: ModifyApp.

Name Type Required Description
DigitalHuman DigitalHumanConfig Yes Digital human configuration
EnableDigitalHuman Boolean Yes Enable digital human
EnableVoiceCall Boolean Yes Enable voice call
EnableVoiceInteract Boolean Yes Enable voice interaction
Voice VoiceConfig Yes Voice type configuration

AIOptimizeModel

AI one-click optimization model configuration

Used by actions: ModifyApp.

Name Type Required Description
Model ModelDetailInfo Yes Model configuration

AccessKeyAuthConfig

AccessKey authentication configuration

Used by actions: CreatePlugin.

Name Type Required Description
ParamList Array of AccessKeyParamConfig No

Access Key field configuration

PassThroughConfig AccessKeyPassThroughConfig No

Access Key passthrough configuration

UsageMode Integer No

Access Key usage mode

Enumeration values:

  • 1: Access Key pass-through

AccessKeyParamConfig

Access Key Field Configuration

Used by actions: CreatePlugin.

Name Type Required Description
FieldType Integer No

Access Key field type. 1: AccessKeyId, 2: AccessKeySecret, 3: SessionToken

IsRequired Boolean No

Required or not

ParamName String No

header/query field name

ParamValue String No

Default value of the AccessKey, which can be empty.

AccessKeyPassThroughConfig

Access Key passthrough configuration

Used by actions: CreatePlugin.

Name Type Required Description
KeyLocation Integer No

Unified injection position of the Access Key field. 0: Header, 1: Query

AccountInfo

Employee information

Used by actions: DescribeAccountList, DescribeAuditLogList.

Name Type Required Description
AccountUin String No

Employee sub-account id

NickName String No

Employee nickname

Avatar String No

Employee avatar

AgentAdvancedConfig

Agent advanced setting

Used by actions: CreateAgent, DescribeAgentDetail, DescribeAgentSummaryList, ModifyAgent.

Name Type Required Description
MaxReasoningRound Integer No

Maximum reasoning round

AgentCollaborationConfig

Agent collaboration configuration

Used by actions: ModifyApp.

Name Type Required Description
AgentCollaborationMode Integer Yes Collaboration mode. Enumeration values: 1: Free transfer: Agents can freely transmit tasks with each other. 2: Workflow orchestration: Collaboration based on predefined processes. 3: Plan-and-Execute: A collaboration mode with separate planning and execution.
WorkflowId String Yes Workflow ID.
WorkflowName String Yes Workflow name.

AgentDetail

Agent details

Used by actions: DescribeAgentDetail.

Name Type Description
AgentId String

Agent ID

Profile AgentProfile

Agent Basic Configuration

Instructions String

System prompt

Model AgentModelConfig

Model information

ToolList Array of AgentTool

Tool details

PluginList Array of AgentPlugin

Plug-in configuration

SkillList Array of AgentSkill

Skill details.

AdvancedConfig AgentAdvancedConfig

Advanced configurations.

ExternalToolList Array of AgentExternalToolConfig

List of Function Tools executed by the caller

Input parameter limit: only available in client user state Agent scenario. This field is ignored in business configuration state Agent

AgentExternalToolConfig

Function Tool configuration executed by the caller

Used by actions: CreateAgent, DescribeAgentDetail, ModifyAgent.

Name Type Required Description
Type String No

Tool type

Input parameter limit: currently only support "function"

Name String No

Tool name

Description String No

Tool description

Parameters Array of RequestParam No

Tool input parameter definition

AgentInput

Agent input value. Supports direct assignment and reference.

Used by actions: CreateAgent, DescribeAgentDetail, ModifyAgent.

Name Type Required Description
InputType Integer No

Input source type: 0 user input, 3 custom variable (API parameter)

UserInputValue AgentUserInputValue No

User handwriting input

SystemVariable AgentSystemVariable No

System parameter

CustomVariableId String No

Custom Variable (API parameter)

EnvVariableId String No

Environment variable parameter

AppVariableId String No

Application variable parameters

AgentModelConfig

Model definition in the Agent configuration

Used by actions: CreateAgent, DescribeAgentDetail, ModifyAgent.

Name Type Required Description
ModelId String No

Unique model id

Alias String No

Model alias

ContextWordsLimit Integer No

Model context length character limit

InstructionsWordsLimit Integer No

Instruction length character limit

ModelParameters ModelParams No

Model parameters

AgentPlugin

Plugin information of the Agent

Used by actions: DescribeAgentDetail.

Name Type Description
Config AgentPluginConfig

Basic plug-in configuration

Name String

Plugin name.

IconUrl String

Plug-in icon url

Description String

Plugin description

PluginClass Integer

Plug-in product type

Enumeration values:

  • 0: ordinary plug-in
  • 1: connector plug-in
Status Integer

Plug-in status

Enumeration values:

  • 0: unknown
  • 1: available
  • 2: unavailable
AuthConfigStatus Integer

Plug-in authentication configuration status

Enumeration values:

  • 0: No authorization required
  • 1: Unconfigured
  • 2: Configured

AgentPluginConfig

Basic plug-in configuration of the Agent

Used by actions: CreateAgent, DescribeAgentDetail, ModifyAgent.

Name Type Required Description
PluginId String No

plugin_id

HeaderParameterList Array of AgentPluginParameter No

Plug-in Header parameter

QueryParameterList Array of AgentPluginParameter No

Plug-in Query parameter

EnableCamRoleAuth Boolean No

Whether to use CAM one-click authorization. This parameter is valid only when auth_type=2

AuthType Integer No

Authorization type

Enumeration values:

  • 0: No authentication
  • 1: API Key
  • 2: CAM authorization
  • 3: OAuth2.0 authorization
OAuthConsent Integer No

OAuth authorization and consent mode; 0 - developer authorization; 1 - user authorization (valid only when auth_type=3)

CredentialConfig AgentPluginCredentialConfig No

Credential configuration

AgentPluginCredentialConfig

Agent plug-in credential configuration

Used by actions: CreateAgent, ModifyAgent.

Name Type Required Description
AuthValueSource Integer No

Plugin authentication value source

Enumeration values:

  • 0: Unspecified
  • 1: Use the default authentication value of the plug-in. Only APIKey/AccessKey is supported.
  • 2: Refer to a credential
  • 3: Refer to a variable
CredentialId String No

Credential ID

Input parameter limit: required when AuthValueSource=2

ParamList Array of AgentPluginCredentialParam No

Parameter configuration

AgentPluginCredentialParam

Credential parameter configuration of the Agent plug-in (variable mode)

Used by actions: CreateAgent, ModifyAgent.

Name Type Required Description
KeyLocation Integer No

Parameter location

Enumeration values:

  • 0: Header authentication
  • 1: Query authentication
Name String No

Parameter name

Input AgentInput No

Source of parameter value

AgentPluginParameter

Agent plug-in parameter configuration

Used by actions: CreateAgent, DescribeAgentDetail, ModifyAgent.

Name Type Required Description
Name String No

Parameter name

IsRequired Boolean No

Required or not

Input AgentInput No

Input value

AgentProfile

Basic configuration of the Agent

Used by actions: CreateAgent, DescribeAgentDetail, DescribeAgentSummaryList, ModifyAgent.

Name Type Required Description
Name String No

Agent Name

IconUrl String No

Icon URL

Role Integer No

Agent role: 0=primary / 1=secondary

Description String No

Agent description

AppName String No

Application name.

Developer String No

Developer

ParentAgentId String No

Primary AgentId, read-only, cannot be updated through API modification

AgentRelease

Agent Deployment project detail

Used by actions: DescribeAgentReleasePreviewList.

Name Type Description
ItemName String

Name.

UpdateTime String

Update time, unix timestamp in seconds (s)

ActionDescription String

Action description.

ReleaseMessage String

Change to test

AgentReleasePreview

Agent release preview information

Used by actions: DescribeAgentReleasePreviewList.

Name Type Description
AgentId String

AgentID

Name String

Agent Name

UpdateTime String

Update time, unix timestamp in seconds (s)

Action Integer

Status, status value: 1: Add new, 2: Modify, 3: Delete

ActionDescription String

Action description.

Message String

Publish a message

ReleaseList Array of AgentRelease

Release detail

AgentSkill

Agent skill details

Used by actions: DescribeAgentDetail.

Name Type Description
SkillId String

skillId

Name String

skill name

Description String

Skill description

DisplayName String

skill display name

DisplayDescription String

Skill show description

IconUrl String

skill icon url

SourceType Integer

Skill source

CurrentVersion String

Skill version

AgentSkillConfig

Agent skill input parameter

Used by actions: CreateAgent, ModifyAgent.

Name Type Required Description
SkillId String No

Skill ID

AgentSpec

Editable configuration of the Agent

Used by actions: CreateAgent, ModifyAgent.

Name Type Required Description
Profile AgentProfile No

Agent Basic Configuration

Instructions String No

System prompt

Model AgentModelConfig No

Primary model configuration

ToolList Array of AgentToolConfig No

Tool information

PluginList Array of AgentPluginConfig No

Plugin information.

SkillList Array of AgentSkillConfig No

Skill information.

AdvancedConfig AgentAdvancedConfig No

Advanced settings

ExternalToolList Array of AgentExternalToolConfig No

List of Function Tools executed by the caller

Input parameter limit: only available in client user state Agent scenarios. B-end configuration state Agent ignores this field and

AgentSummary

Agent digest information

Used by actions: DescribeAgentSummaryList.

Name Type Description
AgentId String

AgentId

Profile AgentProfile

Agent Identity Portrait

AdvancedConfig AgentAdvancedConfig

Advanced setting; returned when scope=0

AgentSystemVariable

System parameters

Used by actions: CreateAgent, DescribeAgentDetail, ModifyAgent.

Name Type Required Description
Name String No

System parameter name

DialogHistoryLimit Integer No

Configuration of dialogue history rounds; used only when Input is "dialogue history" in system variables;

AgentTool

Agent tool details

Used by actions: DescribeAgentDetail.

Name Type Description
Config AgentToolBasicConfig

Tool configuration field

Name String

Tool name

Status Integer

Tool status

Enumeration values:

  • 1: available
  • 2: unavailable
  • 3: invalid
StreamMode Integer

Calling method

Enumeration values:

  • 0: Non-streaming
  • 1: Streaming
ToolAccessMode Integer

Tool access mode

Enumeration values:

  • 0: Not specified
  • 1: Read-only
  • 2: Write/Delete

AgentToolBasicConfig

Basic tool foundation configuration of the Agent

Used by actions: CreateAgent, DescribeAgentDetail, ModifyAgent.

Name Type Required Description
PluginId String No

plugin_id

ToolId String No

Tool id

Description String No

Description.

InputList Array of AgentToolInputParameter No

Tool input parameter list

OutputList Array of AgentToolOutputParameter No

Tool output parameter list

HeaderParameterList Array of AgentPluginParameter No

Tool Header parameter list

QueryParameterList Array of AgentPluginParameter No

Tool Query parameter list

ToolSource Integer No

Tool source: 0-comes from plug-in, 1-comes from workflow

IsDisabled Boolean No

Whether to disable

AgentToolConfig

Agent tool input parameter

Used by actions: CreateAgent, ModifyAgent.

Name Type Required Description
Config AgentToolBasicConfig No

Tool configuration

AgentToolInputParameter

Agent tool input parameter definition

Used by actions: CreateAgent, DescribeAgentDetail, ModifyAgent.

Name Type Required Description
Name String No

Tool name

Description String No

Tool description

Type Integer No

Tool parameter type

Enumeration values:

  • 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
  • 20: ARRAY_ARRAY
  • 99: NULL
IsRequired Boolean No

Required or not

SubParameterList Array of AgentToolInputParameter No

Sub-parameter, used only when the data type is OBJECT or ARRAY<>

IsHidden Boolean No

Whether to hide from the model in mode

OneOfList Array of AgentToolInputParameter No

Parameters in types of OneOf

AnyOfList Array of AgentToolInputParameter No

Parameters in types of AnyOf

Input AgentInput No

Source of parameter value

AgentToolOutputParameter

Agent tool output parameter

Used by actions: CreateAgent, DescribeAgentDetail, ModifyAgent.

Name Type Required Description
Name String No

Parameter name

Description String No

Variable description

Type Integer No

Parameter type

Enumeration values:

  • 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
  • 20: ARRAY_ARRAY
  • 99: NULL
SubParameterList Array of AgentToolOutputParameter No

Sub-parameter, used only when the data type is OBJECT or ARRAY_OBJECT

RenderMode Integer No

Parsing method

AgentUserInputValue

User input value

Used by actions: CreateAgent, DescribeAgentDetail, ModifyAgent.

Name Type Required Description
ValueList Array of String No

User input parameter value

ApiKeyAuthConfig

ApiKey authentication configuration

Used by actions: CreatePlugin.

Name Type Required Description
KeyLocation Integer Yes Key position. HEADER/QUERY

Enumeration values:
| uint | Description |
| --- | --- |
Header authentication
| 1 | Query authentication |
KeyParamName String Yes Key parameter name
KeyParamValue String Yes Key parameter value

ApiPluginConfig

API plug-in configuration

Used by actions: CreatePlugin.

Name Type Required Description
AuthConfig AuthConfig No Authorization configuration message

ApiToolConfig

ApiToolConfig

Used by actions: CreatePlugin.

Name Type Required Description
Body Array of RequestParam No

Request body parameters

Example ToolExample No

Example

ExternalApiUrl String No

External call address of API plug-in

Header Array of RequestParam No

Header

Method String No

Request method

Outputs Array of ResponseParam No

Output

Query Array of RequestParam No

Query parameter

StreamMode Integer No
Enumeration itemEnumeration valueDescription
STREAM_MODE_UNARY0Non-streaming
STREAM_MODE_STREAMING1Streaming
Url String No

Address

App

Complete information of the application

Used by actions: DescribeApp.

Name Type Required Description
AuxiliaryInfo AppAuxiliaryInfo Yes

Auxiliary information (sub-status/approval/appeal/search for resource/special status)

Config AppConfig Yes

Configuration.

Metadata AppMetadata Yes

Metadata

SecretInfo AppSecretInfo Yes

Application key information

ShareUrlInfo AppShareURLInfo Yes

Sharing link information (including access control)

Status AppStatusInfo Yes

Status.

CorpShareConfig CorpShareConfig No

Business shared configuration

SharedKbList Array of AppSharedKbInfo No

List of shared knowledge bases referenced by the application

PortalShareConfig PortalShareConfig No

portal shared configuration

FileVolumeMountList Array of FileVolumeMount No

Application-mounted cloud disk

AppAdvancedConf

Advanced app configuration

Used by actions: ModifyApp.

Name Type Required Description
EnableContextRewrite Boolean Yes

Whether to enable context rewrite

EnableImageTextRetrieval Boolean Yes

Whether to enable image and text retrieval.

ReplyFlexibility Integer Yes

Reply flexibility

DialogCustomConfig DialogCustomConfig No

Custom configuration on the dialogue side (shared across all modes, with permission to modify configuration dynamically during a dialogue)

IntentAchievement Array of IntentAchievementInfo No

Intent attainment priority

AppAppeal

Application appeal information (non-modifiable by users)

Used by actions: DescribeApp.

Name Type Required Description
AppealingStatus AppealingStatus Yes Configuration items in an appeal

AppAuxiliaryInfo

Application auxiliary information - contains various auxiliary statuses and extended information (non-modifiable by users)

Used by actions: DescribeApp.

Name Type Required Description
Appeal AppAppeal Yes Appeal information.
SearchResourceStatus SearchResourceStatusInfo Yes Search for resource status
SpecialStatusInfo SpecialStatusInfo Yes Special status information
SubStatus AppSubStatusInfo Yes Sub-status information.

AppConfig

App configuration - All user-modifiable configurations

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
Experience AppExperienceConfig Yes Trial configuration
Greeting AppGreetingConfig Yes Welcome message configuration
Memory AppMemoryConfig Yes Memory configuration
Mode AppModeConfig Yes Mode-related configuration
Model AppModelConfig Yes Model configuration
WebSearch AppWebSearchConfig Yes Online search configuration
Workflow AppWorkflowConfig Yes Workflow configuration

AppExperienceConfig

Trial configuration

Used by actions: ModifyApp.

Name Type Required Description
Advanced AppAdvancedConf Yes Advanced configuration
Conversation ConversationExperience Yes Dialogue experience configuration
Role RoleConfig Yes Role configuration

AppFileVolumeMount

Application-level cloud disk mounting configuration

Used by actions: ModifyApp.

Name Type Required Description
FileVolumeMount FileVolumeMount No

Application cloud disk configuration

Action Integer No

1: Add new 2: Modify 3: Delete

AppGreetingConfig

Welcome message configuration

Used by actions: ModifyApp.

Name Type Required Description
Greeting String Yes

Welcome message content

OpeningQuestionList Array of String No

Opening problem list

AppIdentity

Application identifier

Used by actions: DescribeSkillReferenceList.

Name Type Required Description
AppId String No

Application ID.

AppName String No

Application name.

AppMode Integer No

Application mode

Enumeration values:

  • 1: Standard mode
  • 2: agent mode
  • 3: Single workflow mode
  • 4: ClawAgent mode

AppMemoryConfig

Memory configuration

Used by actions: ModifyApp.

Name Type Required Description
Enabled Boolean Yes Whether to enable long-term memory
LongMemoryDay Integer Yes Long memory duration
Model ModelDetailInfo Yes Model configuration
PromptContent String Yes prompt content
PromptMode Integer Yes Prompt word mode. Enumeration value: 1: custom

AppMetadata

Application metadata - basic identification and description information

Used by actions: DescribeApp.

Name Type Required Description
AppId String Yes Application ID
AppMode Integer Yes Application mode. Enumeration values: 1: Standard mode, 2: Agent mode, 3: Single workflow mode, 4: ClawAgent mode
Avatar String Yes App avatar
CreateTime String Yes Creation time (Unix timestamp in seconds).
Description String Yes Application description
Name String Yes Superapp name
SpaceId String Yes Space ID.
UpdateTime String Yes Update time (Unix timestamp in seconds).

AppModeConfig

Mode configuration - Contains unique configurations for different modes

Used by actions: ModifyApp.

Name Type Required Description
MultiAgentConfig MultiAgentConfig Yes Multi-agent configuration (Agent mode)
SingleWorkflowConfig SingleWorkflowConfig Yes Single workflow configuration (single workflow mode)
ClawAgentConfig ClawAgentConfig No ClawAgent Configuration (ClawAgent mode)

AppModelConfig

Model configuration

Used by actions: ModifyApp.

Name Type Required Description
AiOptimizeModel AIOptimizeModel Yes AI one-click optimization model
FileParseModel FileParseModel Yes Real-time file parsing model
GenerateModel GenerateModel Yes Generate model configuration
MultiModalQaModel MultiModalQAModel Yes Multimodal QA model
MultiModalUnderstandingModel MultiModalUnderstandingModel Yes Multimodal understanding model
PromptRewriteModel PromptRewriteModel Yes Prompt rewrite model
ThinkModel ThinkModel Yes Thinking model configuration

AppOperation

App operation information

Used by actions: DescribeAppSummaryList.

Name Type Required Description
Creator String Yes Creator
CreatorUin String Yes Creator UIN
CreatorUserAccount String Yes Creator account (for private scenarios)
UpdateTime String Yes Last modified (Unix timestamp in seconds).
Updater String Yes Last modified by
UpdaterUin String Yes Modifier UIN

AppPluginConfig

App plugin configuration message

Used by actions: CreatePlugin.

Name Type Required Description
AppId String Yes Application ID for creating a plugin based on a published application

AppSecretInfo

Application key information

Used by actions: DescribeApp.

Name Type Required Description
AppKey String Yes Application key
CreateTime String Yes Creation time.

AppShareAccessControl

AppShareAccessControl

Used by actions: CreateRelease, DescribeApp, DescribeLatestRelease, DescribeReleaseSummary.

Name Type Required Description
AccessType Integer No
Enumeration itemEnumeration valueDescription
APP_SHARE_ACCESS_TYPE_UNSPECIFIED0
APP_SHARE_ACCESS_TYPE_PUBLIC1Public access (accessible to all users)
APP_SHARE_ACCESS_TYPE_INTERNAL2Internal access (accessible only to organizational users)
APP_SHARE_ACCESS_TYPE_ACCOUNT_WHITELIST3Account allowlist (accessible to specified UIN/mobile phone/mailbox/IP)
Enabled Boolean No

Whether to enable access control

Enumeration values:

  • true: Enable
  • false: Disable
Whitelist Array of AppShareWhitelistItem No

Whitelist information

AppShareURLInfo

Sharing link information (returned by details query; the non-modifiable part for users; the modifiable part of access_control is handled by ModifyApp)

Used by actions: DescribeApp.

Name Type Required Description
AccessControl AppShareAccessControl Yes Currently effective access control configuration
ShareUrl String Yes Share URL

AppShareWhitelistItem

AppShareWhitelistItem

Used by actions: CreateRelease, DescribeLatestRelease, DescribeReleaseSummary.

Name Type Required Description
Type Integer No
Enumeration item Enumeration value Description
APP_SHARE_WHITELIST_TYPE_UNSPECIFIED 0
APP_SHARE_WHITELIST_TYPE_UIN 1 UIN account
APP_SHARE_WHITELIST_TYPE_PHONE 2 Mobile number
APP_SHARE_WHITELIST_TYPE_EMAIL 3 Email address
APP_SHARE_WHITELIST_TYPE_IP 4 IP address
APP_SHARE_WHITELIST_TYPE_RTX 5 RTX account
Values Array of String No

Allowlist array information

Parameter format: allowlist value

AppSharedKbInfo

Brief information of the shared knowledge base referenced by the app (only ID and name are returned during queries)

Used by actions: DescribeApp.

Name Type Required Description
KbId String Yes Shared knowledge base ID
KbName String Yes Name of the shared knowledge base

AppStatusInfo

Application status information - runtime status information (non-modifiable by users)

Used by actions: DescribeApp, DescribeAppSummaryList.

Name Type Required Description
Status Integer Yes

Application status

Enumeration values:

  • 1: not launched
  • 2: running
  • 3: disabled
  • 4: importing
StatusDescription String Yes

Status description.

AppSubStatusInfo

Application sub-status information.

Used by actions: DescribeApp, DescribeAppSummaryList.

Name Type Required Description
ApprovalId String Yes Approval record ID (valid when sub_status_list contains PUBLISH_APPROVING)
SubStatusList Array of Integer No Application sub-status list (possibly in multiple sub-statuses at the same time)

AppSummary

Application abstract - Application information returned by the list query

Used by actions: DescribeAppSummaryList.

Name Type Required Description
AppId String Yes

Application ID.

AppMode Integer Yes

Application mode. Enumeration values: 1: standard mode, 2: Agent mode, 3: single workflow mode, 4: ClawAgent mode

Avatar String Yes

Application avatar

Name String Yes

Application name.

OperationInfo AppOperation Yes

Operation information

Status AppStatusInfo Yes

Status information

SubStatus AppSubStatusInfo Yes

Sub-status information

PermissionIdList Array of String No

Resource operation permissions

Description String No

Application description information

AppToolConfig

AppToolConfig

Used by actions: CreatePlugin.

Name Type Required Description
Inputs Array of RequestParam No

Input parameter

Outputs Array of ResponseParam No

Output parameters

AppTrigger

AppTrigger

Used by actions: DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
AppId String No

Application ID.

ExecuteConfig ExecuteConfig No

Execution configuration

ExecuteType Integer No
Enumeration item Enumeration value Description
APP_TRIGGER_EXECUTE_TYPE_UNSPECIFIED 0 Unspecified
APP_TRIGGER_EXECUTE_TYPE_PROMPT 1 Command execution
APP_TRIGGER_EXECUTE_TYPE_WORKFLOW 2 Workflow execution
FailedCount String No

Number of failures

PushConfig TimerPushConfig No

Push channel configuration

Scope Integer No
Enumeration item Enumeration value Description
APP_TRIGGER_SCOPE_UNSPECIFIED 0 Unspecified
APP_TRIGGER_SCOPE_APP 1 B-end admin
APP_TRIGGER_SCOPE_USER 2 C-end visitor
Status Integer No
Enumeration itemEnumeration valueDescription
APP_TRIGGER_STATUS_UNSPECIFIED0Unspecified
APP_TRIGGER_STATUS_ENABLED1Enablement
APP_TRIGGER_STATUS_PAUSED2Suspension
APP_TRIGGER_STATUS_DELETED3Deleted
SuccessCount String No

Number of successes

TriggerConfig TriggerConfig No

Trigger configuration

TriggerId String No

Trigger ID

TriggerName String No

Trigger name

TriggerStatus TriggerStatus No

Trigger status

TriggerType Integer No
Enumeration itemEnumeration valueDescription
APP_TRIGGER_TYPE_UNSPECIFIED0Unspecified
APP_TRIGGER_TYPE_SCHEDULED1Scheduled trigger
APP_TRIGGER_TYPE_WEBHOOK2Webhook trigger
UserId String No

Visitor ID

AppTriggerInstance

AppTriggerInstance

Used by actions: DescribeAppTriggerInstance.

Name Type Required Description
AppId String No

Application id

ConversationId String No

Session id

CreatedAt String No

Trigger creation time

FinishedAt String No

End time.

InstanceId String No

Trigger running instance id

RequestId String No

Request ID

ResultCode String No

Result code

ResultSummary String No

Result Summary

RunId String No

Single dialogue id

Scope Integer No
Enumeration item Enumeration value Description
APP_TRIGGER_SCOPE_UNSPECIFIED 0 Unspecified
APP_TRIGGER_SCOPE_APP 1 B-end admin
APP_TRIGGER_SCOPE_USER 2 C-end visitor
Source Integer No
Enumeration itemEnumeration valueDescription
APP_TRIGGER_INSTANCE_SOURCE_UNSPECIFIED0Unspecified
APP_TRIGGER_INSTANCE_SOURCE_APP_TRIGGER1Originates from an application trigger
StartedAt String No

Trigger start execution time

Status Integer No
Enumeration item Enumeration value Description
TIMER_RUN_STATUS_UNSPECIFIED 0 Unspecified
TIMER_RUN_STATUS_PENDING 1 Waiting to execute
TIMER_RUN_STATUS_RUNNING 2 Executing
TIMER_RUN_STATUS_RETRY_WAIT 3 Wait for retry
TIMER_RUN_STATUS_SUCCESS 4 Successful
TIMER_RUN_STATUS_DEAD 5 Failure final state (retry exhausted / non-retriable)
TIMER_RUN_STATUS_CANCELLED 6 Cancelled by task pause/deletion/modification
TraceId String No

TraceId, used for logging

TriggerId String No

Trigger id

UserId String No

Visitor ID

WorkflowRunId String No

Workflow running ID

AppTriggerParamBinding

AppTriggerParamBinding

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
ParamName String No

Parameter name.

ParamType Integer No

Parameter type

Enumeration values:

  • 0: string
  • 1: integer
  • 2: floating-point number
  • 4: object
  • 5: string array
  • 6: integer array
  • 7: floating-point number array
  • 8: boolean value array
  • 3: boolean value
  • 9: object array
  • 10: file
  • 11: document
  • 12: image
  • 13: audio
  • 14: video
  • 15: file array
  • 16: document array
  • 17: image array
  • 18: audio array
  • 19: video array
  • 20: nested array
  • 22: key
  • 99: null
  • 100: unspecified type, for OneOf and AnyOf scenarios
Value AppTriggerParamBindingValue No

Parameter value

AppTriggerParamBindingConfig

AppTriggerParamBindingConfig

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
ParamList Array of AppTriggerParamBinding No

Bind parameter list

AppTriggerParamBindingValue

AppTriggerParamBindingValue

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
ParamValue String No

Parameter value

VariableName String No

Application variable name

AppTriggerParamSchema

AppTriggerParamSchema

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
ParamName String No

Parameter name

ParamType Integer No
Enumeration itemEnumeration valueDescription
PARAM_TYPE_STRING0String
PARAM_TYPE_INT1Integer
PARAM_TYPE_FLOAT2Floating-point number
PARAM_TYPE_BOOL3Boolean value
PARAM_TYPE_OBJECT4Object
PARAM_TYPE_ARRAY_STRING5String array
PARAM_TYPE_ARRAY_INT6Integer array
PARAM_TYPE_ARRAY_FLOAT7Floating-point number array
PARAM_TYPE_ARRAY_BOOL8Boolean value array
PARAM_TYPE_ARRAY_OBJECT9Object array
PARAM_TYPE_ARRAY_ARRAY20Nested array
PARAM_TYPE_NULL99Null
PARAM_TYPE_UNSPECIFIED100Unspecified type, used for OneOf and AnyOf scenarios
Required Boolean No

Required or optional

SubParamList Array of AppTriggerParamSchema No

Sub-parameter list

AppTriggerPromptExecuteConfig

AppTriggerPromptExecuteConfig

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
ExecutePrompt String No

Trigger execution prompt content

ParamBindingsApi AppTriggerParamBindingConfig No

api parameter binding

AppTriggerRunLog

AppTriggerRunLog

Used by actions: DescribeAppTriggerRunLogList.

Name Type Required Description
ConversationId String No

Session id

DurationMs String No

Execution time

EndTime String No

End time

Parameter format: YYYY-MM-DD hh:mm:ss

FireType Integer No
Enumeration item Enumeration value Description
APP_TRIGGER_FIRE_TYPE_UNSPECIFIED 0 Unspecified
APP_TRIGGER_FIRE_TYPE_SCHEDULED 1 Scheduled trigger
APP_TRIGGER_FIRE_TYPE_WEBHOOK 2 Webhook trigger
APP_TRIGGER_FIRE_TYPE_MANUAL_RUN 3 Manual immediate execution
APP_TRIGGER_FIRE_TYPE_TEST_RUN 4 Test execution
InstanceId String No

Trigger instance id

PushStatus Integer No
Enumeration item Enumeration value Description
TIMER_RUN_PUSH_STATUS_UNSPECIFIED 0 Unspecified
TIMER_RUN_PUSH_STATUS_NONE 1 Push notification not configured
TIMER_RUN_PUSH_STATUS_WAITING 2 Pending
TIMER_RUN_PUSH_STATUS_SUCCESS 3 Push successful
TIMER_RUN_PUSH_STATUS_FAILED 4 Push failure
ResultCode String No

Result code

ResultSummary String No

Result Overview

RunId String No

Single dialogue id

ScheduledFireTime String No

Trigger time

Parameter format: YYYY:MM:DD hh:mm:ss

Scope Integer No
Enumeration item Enumeration value Description
APP_TRIGGER_SCOPE_UNSPECIFIED 0 Unspecified
APP_TRIGGER_SCOPE_APP 1 B-end admin
APP_TRIGGER_SCOPE_USER 2 C-end visitor
StartTime String No

Execution start time

Parameter format: YYYY:MM:DD hh:mm:ss

Status Integer No
Enumeration item Enumeration value Description
TIMER_RUN_STATUS_UNSPECIFIED 0 Unspecified
TIMER_RUN_STATUS_PENDING 1 Waiting to execute
TIMER_RUN_STATUS_RUNNING 2 Executing
TIMER_RUN_STATUS_RETRY_WAIT 3 Wait for retry
TIMER_RUN_STATUS_SUCCESS 4 Successful
TIMER_RUN_STATUS_DEAD 5 Failed final state (retry exhausted / non-retriable)
TIMER_RUN_STATUS_CANCELLED 6 Cancelled due to task pause/deletion/modification
TriggerId String No

Trigger id

Unread Boolean No

Whether it has been read

UserId String No

Visitor Id

WorkflowRunId String No

Workflow run id

AppTriggerScheduleConfig

AppTriggerScheduleConfig

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
Schedule TimerScheduleConfig No

Trigger scheduled configuration.

AppTriggerScheduleStatus

AppTriggerScheduleStatus

Used by actions: DescribeAppTrigger, DescribeAppTriggerSummaryList, ModifyAppTrigger.

Name Type Required Description
LastFireTime String No

Last trigger time

Parameter format: YYYY-MM-DD hh:mm:ss

NextFireTime String No

Next trigger time

Parameter format: YYYY-MM-DD hh:mm:ss

PolicySummary String No

Trigger mode

AppTriggerSummary

AppTriggerSummary

Used by actions: DescribeAppTriggerSummaryList.

Name Type Required Description
AppId String No

Application ID.

ExecuteType Integer No
Enumeration itemEnumeration valueDescription
APP_TRIGGER_EXECUTE_TYPE_UNSPECIFIED0Unspecified
APP_TRIGGER_EXECUTE_TYPE_PROMPT1Command execution
APP_TRIGGER_EXECUTE_TYPE_WORKFLOW2Workflow execution
FailedCount String No

Number of failures

LastSessionId String No

Last session id

Scope Integer No
Enumeration item Enumeration value Description
APP_TRIGGER_SCOPE_UNSPECIFIED 0 Unspecified
APP_TRIGGER_SCOPE_APP 1 B-end admin
APP_TRIGGER_SCOPE_USER 2 C-end visitor

Value range: [0, 2]

Status Integer No
Enumeration item Enumeration value Description
APP_TRIGGER_STATUS_UNSPECIFIED 0 Unspecified
APP_TRIGGER_STATUS_ENABLED 1 Enablement
APP_TRIGGER_STATUS_PAUSED 2 Suspension
APP_TRIGGER_STATUS_DELETED 3 Deleted
SuccessCount String No

Number of successes

TriggerId String No

Trigger id.

TriggerName String No

Trigger name

TriggerStatus TriggerStatus No

Trigger execution status

TriggerType Integer No
Enumeration item Enumeration value Description
APP_TRIGGER_TYPE_UNSPECIFIED 0 Unspecified
APP_TRIGGER_TYPE_SCHEDULED 1 Scheduled trigger
APP_TRIGGER_TYPE_WEBHOOK 2 Webhook trigger
UnreadRunLogCount String No

The number of unread logs

UserId String No

Visitor ID.

AppTriggerWebhookConfig

AppTriggerWebhookConfig

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
ParamSchemaConfig AppTriggerWebhookParamSchemaConfig No

Trigger webhook parameter configuration

WebhookKey String No

key of the webhook

WebhookToken String No

webhook key

WebhookUrl String No

webhook domain name or IP address

AppTriggerWebhookParamSchemaConfig

AppTriggerWebhookParamSchemaConfig

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
SchemaList Array of AppTriggerParamSchema No

Trigger API parameter list

AppTriggerWebhookStatus

AppTriggerWebhookStatus

Used by actions: DescribeAppTrigger, DescribeAppTriggerSummaryList, ModifyAppTrigger.

Name Type Required Description
WebhookUrl String No

Push Webbook address

AppTriggerWorkflowExecuteConfig

AppTriggerWorkflowExecuteConfig

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
ParamBindingsApi AppTriggerParamBindingConfig No

Workflow API parameter binding

ParamBindingsWorkflow AppTriggerParamBindingConfig No

Workflow parameter binding

WorkflowId String No

Workflow ID

WorkflowName String No

Workflow name

AppWebSearchConfig

Online search configuration (for international edition)

Used by actions: ModifyApp.

Name Type Required Description
ApiKey String Yes API key
Enabled Boolean Yes Whether enabled
Provider String Yes Service provider
TopN Integer Yes Number of returned results.

AppWorkflowConfig

Workflow configuration

Used by actions: ModifyApp.

Name Type Required Description
EnablePDL Boolean Yes Whether to use PDL

AppealingStatus

Configuration in appeal - Record whether each configuration item is in appeal

Used by actions: DescribeApp.

Name Type Required Description
AvatarInAppeal Boolean Yes Whether the avatar is under appeal
FallbackReplyInAppeal Boolean Yes Is the fallback response included in the appeal?
GreetingInAppeal Boolean Yes Whether the welcome message is required in an appeal
NameInAppeal Boolean Yes Whether the application name is under appeal
RoleInAppeal Boolean Yes Whether the role description is in the appeal

AuditLog

Operation log

Used by actions: DescribeAuditLogList.

Name Type Required Description
AccountInfo AccountInfo No

Employee information

AppId String No

Application business id

AppName String No

Application name

Name when the operation log is triggered

OperateTime String No

Operation time

Parameter format: timestamp in seconds

Action String No

Operation type.

Biz String No

Operation object.

Content String No

Operation content

UniqueId String No

Unique ID for the operation.

AuthConfig

Plugin authorization configuration

Used by actions: CreatePlugin.

Name Type Required Description
AuthType Integer Yes

Authorization mode.

Enumeration values:

  • 0: No authentication
  • 1: API Key authentication
  • 2: CAM authorization
  • 3: OAuth 2.0 authorization
ApiKeyAuthConfig ApiKeyAuthConfig No

API Key Authorization Configuration

CamAuthConfig CamAuthConfig No

CAM Authorization Configuration

OAuthConfig OAuthConfig No

OAuth 2.0 authorization configuration

AccessKeyAuthConfig AccessKeyAuthConfig No

AccessKey authorization configuration

BackgroundImage

BackgroundImage configuration

Used by actions: ModifyApp.

Name Type Required Description
Brightness Integer Yes Brightness level
LandscapeImageUrl String Yes Landscape image (pc)
OriginalImageUrl String Yes Original image
PortraitImageUrl String Yes Long image (mobile phone)
ThemeColor String Yes Theme color

BasicBilling

BasicBilling

Used by actions: CreatePlugin.

Name Type Required Description
BillingUnit Integer No
Enumeration itemEnumeration valueDescription
UNKNOW0
TOKEN1By token
PAGE_COUNT2By page number
TIMES3By times
TIMES_THOUSAND4By thousand times
SECOND5By duration
CHARACTER6By number of characters
CHARACTER_THOUSAND7By thousand characters
SHEET8By sheet
NUMBER9By count
CashPrice Float No

Cash price

Unit: CNY

PuPrice Float No

PU price

Unit: pu

BatchRunSummary

BatchRunSummary

Used by actions: DescribeNodeRunDetail.

Name Type Required Description
FailedCount Integer No Number of failures.
SuccessCount Integer No Number of successes.
TotalCount Integer No Total batches
FailedIndexList Array of Integer No Failed subscript
JustCompletedIndexList Array of Integer No Batches completed in the previous round
RunningIndexList Array of Integer No Subscript in running
SuccessIndexList Array of Integer No Subscript of success

BillingAttribute

BillingAttribute

Used by actions: CreatePlugin.

Name Type Required Description
Name String No

Property name

Value String No

Attribute value.

CallSource

Call source

Used by actions: DescribeConcurrencyLimitDetailList.

Name Type Required Description
SubjectId String No

Caller ID, whose meaning is determined by subject_type (such as app_id, kb_id)

SubjectName String No

Name of the calling entity

SubjectType Integer No

Caller type: APP/KB/WIDGET/OPEN_CLAW/KB_RECALL_TEST/WORKBENCH/MODEL_API

Enumeration itemEnumeration valueDescription
METRIC_SOURCE_TYPE_UNSPECIFIED0
METRIC_SOURCE_TYPE_APP1Application development
METRIC_SOURCE_TYPE_KB2Knowledge base
METRIC_SOURCE_TYPE_WIDGET3Widget
METRIC_SOURCE_TYPE_OPEN_CLAW4ClawPro
METRIC_SOURCE_TYPE_KB_RECALL_TEST5Knowledge base recall test
METRIC_SOURCE_TYPE_WORKBENCH6Intelligent workbench
METRIC_SOURCE_TYPE_MODEL_API7Model API call

CamAuthConfig

CAM authorization information

Used by actions: CreatePlugin.

Name Type Required Description
RoleName String Yes

Role name.

KeyLocation Integer No

Key location HEADER/QUERY

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | Header authentication |
| 1 | Request information authentication |

SecretIdName String No

SecretId field name

SecretKeyName String No

SecretKey field name

ParamList Array of AccessKeyParamConfig No

CAM Access Key Field Configuration

SupportRoleAuth Boolean No

Whether CAM role authorization is supported.

CategoryPath

Category path information

Used by actions: DescribeQA, DescribeQASummaryList.

Name Type Required Description
CategoryId String No

Category ID

CategoryIdPath Array of String No

List of category IDs in the path from the root node

CategoryNamePath Array of String No

List of category names in the path from the root node

CategoryPermission

CategoryPermission

Used by actions: DescribeMsgRecordCategoryList.

Name Type Required Description
CanAdd Boolean No

Whether the current user can add subcategories

CanDelete Boolean No

Whether the current user can delete the category

CanEdit Boolean No

Whether the current user can edit this category

CheckResult

Common check results

Used by actions: CheckLabel.

Name Type Required Description
Passed Boolean No Whether the verification passed.
Reason String No Failure reason (filled when passed=false)

ClawAgentAgentTeamConfig

ClawAgent Agent team collaboration configuration

Used by actions: ModifyApp.

Name Type Required Description
Enabled Boolean No

Whether to enable Agent team collaboration

PromptContent String No

prompt content

ClawAgentChannelContextTimeoutConfig

Channel context timeout configuration clearing

Used by actions: ModifyApp.

Name Type Required Description
Enabled Boolean No

Whether to enable channel context timeout clearing

TimeoutHour Integer No

Channel context timeout duration

Value range: [1, 99]

ClawAgentConfig

ClawAgent Configuration

Used by actions: ModifyApp.

Name Type Required Description
AgentTeamConfig ClawAgentAgentTeamConfig No

Agent Team Collaboration Configuration

LongMemoryConfig ClawAgentLongMemoryConfig No

Long-term memory configuration

ChannelContextTimeoutConfig ClawAgentChannelContextTimeoutConfig No

Channel context timeout configuration clearing

ClawAgentLongMemoryConfig

ClawAgent long-term memory configuration

Used by actions: ModifyApp.

Name Type Required Description
Enabled Boolean No

Whether to enable long-term memory

CodeToolConfig

CodeToolConfig

Used by actions: CreatePlugin.

Name Type Required Description
Code String No

Code

Example ToolExample No

Example.

Inputs Array of RequestParam No

Input parameter

Outputs Array of ResponseParam No

Output parameters

ComplexBilling

ComplexBilling

Used by actions: CreatePlugin.

Name Type Required Description
ComplexList Array of ComplexBillingItem No

Composite Billing List

ComplexBillingItem

ComplexBillingItem

Used by actions: CreatePlugin.

Name Type Required Description
BillingAttributeList Array of BillingAttribute No

Composite billing dimensions

BillingUnit Integer No
Enumeration itemEnumeration valueDescription
UNKNOW0
TOKEN1TOKEN-based
PAGE_COUNT2By PAGE NUMBER
TIMES3TIMES-based
TIMES_THOUSAND4By THOUSAND TIMES
SECOND5Duration-based
CHARACTER6By NUMBER of characters
CHARACTER_THOUSAND7By THOUSAND characters
SHEET8By SHEET
NUMBER9By COUNT
CashPrice Float No

Cash price

Unit: CNY

PuPrice Float No

pu price

Unit: pu

ConcurrencyLimitDetail

Concurrency limit exceeded details

Used by actions: DescribeConcurrencyLimitDetailList.

Name Type Required Description
CallSource CallSource No

Call source (subject_type determines the meaning of subject_id/subject_name. For example, for APP, subject_id=app_id and subject_name=app_name)

EventTime String No

Time when the limit was exceeded (Unix seconds)

ModelName String No

Model name

RequestQuery String No

Request content (the original query text of the user request)

SpaceId String No

Space ID

ConflictQA

Conflicting QA (a single QA snapshot in a conflict group)

Used by actions: DescribeConflictQA.

Name Type Required Description
Answer String No

Answer

EffectiveDomain Integer No

Knowledge application scope: 1=disabled, 2=development domain only, 3=release domain only, 4=global

Enumeration itemEnumeration valueDescription
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1Disabled
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2Development domain only
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3Release domain only
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4Global

FileName String No

Associated document name.

FileType String No

Associated document type

QaId String No

QA ID

Question String No

Query

SourceType Integer No

Source type: 1=documentation generation, 2=batch import, 3=manual entry

Enumeration itemEnumeration valueDescription
QA_SOURCE_TYPE_UNKNOWN0
QA_SOURCE_TYPE_DOC1Documentation generation
QA_SOURCE_TYPE_BATCH_IMPORT2Batch import
QA_SOURCE_TYPE_MANUAL3Manual entry

UpdateTime String No

Update time (Unix seconds, for sorting old and new)

ConflictQASummary

Conflict query digest information

Used by actions: DescribeConflictQASummaryList.

Name Type Required Description
ConflictGroupId String No

Conflict group ID

Conversation

Conversation session information

Used by actions: DescribeConversationList.

Name Type Required Description
AppId String Yes

App ID

ConversationId String Yes

Session ID

CreateTime String Yes

Creation time.

Type Integer Yes

Session type enumeration values: 0-CONVERSATION_TYPE_UNSPECIFIED (unspecified; means all in list query), 1-CONVERSATION_TYPE_VISITOR (visitor trial), 2-CONVERSATION_TYPE_EVALUATION (evaluation), 5-CONVERSATION_TYPE_API (API integration), 10-CONVERSATION_TYPE_WORKFLOW (workflow debugging), 20-CONVERSATION_TYPE_SHARE (share a link)

UpdateTime String Yes

Update time.

Title String No

Session title

AgentId String No

Client-side AgentId used by the session

ConversationAgentTask

AgentTask Intelligent Agent task information

Used by actions: DescribeConversationMessageList.

Name Type Required Description
Content String Yes

Task content

Index String Yes

Task number

Status String Yes

Task status. pending: to be executed, processing: processing, success: completed, failed: processing failure, stop: canceled

ConversationContent

Content message information

Used by actions: DescribeConversationMessageList.

Name Type Required Description
Text String Yes

Text content

Type String Yes

Content type. text: text, image: image, file: file, custom_variables: custom input parameter information, widget_action: widget action information

CustomParamList Array of String No

Custom parameter data

CustomParams Array of String No

Custom parameter data

CustomVariablesData String No

Custom variable data

EnterpriseCharts String No

Business form

OptionCardList Array of String No

Tab List

OptionCards Array of String No

Tab list.

OptionMode Integer No

Tab mode. Enumeration values: 0-OPTION_MODE_SINGLE (single selection), 1-OPTION_MODE_MULTI (multiple selection)

QuoteInfoList Array of ConversationQuoteInfo No

Reference marker information list

QuoteInfos Array of ConversationQuoteInfo No

List of reference superscript information

ReferenceList Array of ConversationReference No

Reference source list

References Array of ConversationReference No

Reference list

RelatedRecordId String No

Associated record ID

TaskList Array of ConversationAgentTask No

Intelligent Agent Task List

Tasks Array of ConversationAgentTask No

Intelligent Agent Task List

WorkflowInput String No

Workflow input parameter

McpApp ConversationMcpApp No

MCP-APP call information

ConversationExperience

Dialogue experience configuration

Used by actions: ModifyApp.

Name Type Required Description
AiCall AICallConfig Yes

AI Call Configuration

BackgroundImage BackgroundImage Yes

Background image configuration

EnableFallbackReply Boolean Yes

Fallback response switch

EnableRecommended Boolean Yes

Whether to use recommended questions.

EnableWebSearch Boolean Yes

Whether to use online search.

FallbackReply String Yes

Fallback response

InputBoxConfig InputBoxConfig Yes

Input box configuration

Method Integer Yes

Output method. Enumeration values: 1: streaming, 2: non-streaming

RecommendPromptMode Integer Yes

Recommended question generation prompt mode. Enumeration value: 1: Prompt that outputs recommended questions combined with the knowledge base only

EnableNewMessageInterrupt Boolean No

A new message interrupts the ongoing message

ConversationFileCollection

FileCollection file collection information

Used by actions: DescribeWorkflowRun.

Name Type Required Description
MaxFileCount Integer Yes

Maximum number of files

SupportedFileTypeList Array of String No

Supported file type list

SupportedFileTypes Array of String No

Supported file type list

ConversationMcpApp

MCP App content for reconstructing an interactive app from a historical session

Used by actions: DescribeConversationMessageList.

Name Type Required Description
PluginId String No

Capacity boundary: A single request is read-only for resources belonging to this plugin

ResourceUri String No

ui:// resource, based on which the frontend calls ReadMCPResource to pull HTML

ThreadId String No

thread on the agent-exec side

ToolResult String No

JSON: The complete original CallToolResult for replay when rebuilding historical sessions

ConversationMessage

Message information

Used by actions: DescribeConversationMessageList.

Name Type Required Description
ConversationId String Yes

Session ID.

Icon String Yes

Message icon

MessageId String Yes

Message ID

Name String Yes

Message name

RecordId String Yes

Record ID

Role String Yes

Message role

Status String Yes

Message status. pending: pending execution, processing: in processing, success: completed, failed: processing failure, stop: canceled

StatusDesc String Yes

Status description

Title String Yes

Message title

ContentList Array of ConversationContent No

List of message contents

Contents Array of ConversationContent No

Message content list

Type String No

Type.

ConversationQuoteInfo

Reference source index information of QuoteInfo

Used by actions: DescribeConversationMessageList.

Name Type Required Description
Index Integer Yes

Index value of the reference source

Position Integer Yes

Reference source location

ConversationRecordErrorInfo

Description of a single dialogue failure

Used by actions: DescribeConversationMessageList.

Name Type Required Description
Code String No

Failure error code of the dialogue

Message String No

Dialogue failure error message

ConversationRecordSummary

Statistical information of a single dialogue history

Used by actions: DescribeConversationMessageList.

Name Type Required Description
RecordId String No

Reply record ID, corresponding to the record_id of the reply message in messages

RelatedRecordId String No

ID of the user's question record, corresponding to the record_id of the user message in messages

TimeUsage ConversationRecordTimeUsage No

Duration info of a single dialogue

TokenUsage ConversationRecordTokenUsage No

token consumption information of a single dialogue

ErrorInfo ConversationRecordErrorInfo No

Description of a single dialogue failure; empty if successful

Status String No

Status of a single employee assistant dialogue.

Enumeration values:

  • pending: Pending,
  • processing: Processing,
  • success: Success,
  • failed: Failure,
  • stop: Stopped.

ConversationRecordTimeUsage

Duration info of a single dialogue

Used by actions: DescribeConversationMessageList.

Name Type Required Description
Elapsed String No

Total time consumed for a single dialogue, in milliseconds

FirstTokenCost String No

Time to first token, in milliseconds

TotalCost String No

Total time consumed for model inference, in milliseconds

ConversationRecordTokenUsage

token consumption information of a single dialogue

Used by actions: DescribeConversationMessageList.

Name Type Required Description
InputTokens String No

Total input token count

OutputTokens String No

Total output token count

TotalTokens String No

Total token consumption

CachedTokens String No

Total number of cache hit tokens

ReasoningTokens String No

Total number of reasoning tokens

ConversationReference

Reference source information

Used by actions: DescribeConversationMessageList.

Name Type Required Description
Index Integer Yes

Reference index

Name String Yes

Reference name

Type Integer Yes

REFERENCE source TYPE. Enumeration values: 0-APP_REFERENCE_TYPE_UNSPECIFIED (not specified), 1-APP_REFERENCE_TYPE_QA (QA), 2-APP_REFERENCE_TYPE_SEGMENT (fragment), 3-APP_REFERENCE_TYPE_DOC (document), 4-APP_REFERENCE_TYPE_WEB_SEARCH (WEB SEARCH), 5-APP_REFERENCE_TYPE_GRAPH_RAG (GraphRAG)

ConversationResetInfo

Session reset information

Used by actions: DescribeConversationMessageList.

Name Type Required Description
ResetTime String No

Last reset millisecond-level timestamp

ResetThroughRecordId String No

Last boundary reset; this record and earlier records are no longer used as dialogue context

ConversationWidget

Widget component content information

Used by actions: DescribeWorkflowRun.

Name Type Required Description
EncodedWidget String Yes

Base64-encoded original widget data

Payload String Yes

payload from the user's last submission

Position Integer Yes

Location of the widget in the text

State String Yes

widget status JSON data

View String Yes

widget view data

WidgetId String Yes

component_ID

WidgetRunId String Yes

Component operation ID

ConversationWorkspace

Workspace spatial information

Used by actions: DescribeConversation.

Name Type Required Description
WorkspaceId String Yes

Workspace ID

StorageType String No

Storage type

CorpShareConfig

CorpShareConfig

Used by actions: CreateRelease, DescribeApp, DescribeLatestRelease, DescribeReleaseSummary.

Name Type Required Description
Enabled Boolean No

Business shared switch

ShareScope Integer No

Share scope type. 1: all business staff, 2: designated account, 3: designated space

TagIdList Array of String No

Business shared application tag

ShareScopeList Array of Identity No

Shared range information (for users, StrId is uin and Name is username; for spaces, StrId is space ID and Name is space Name)

CronSchedule

CronSchedule

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
Expression String No Cron expression

CustomVariable

API parameters of the workflow

Used by actions: CreateWorkflowRun, DescribeWorkflowRun.

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

DBRetrievalConfig

Database search configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Enabled Boolean No

Whether to enable

DailySchedule

DailySchedule

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
TimeOfDay String No Time

DialogCustomConfig

Custom configuration for the dialogue side (shared across all modes, with permission to modify configuration dynamically during a dialogue)

Used by actions: ModifyApp.

Name Type Required Description
Enabled Boolean No

Whether to enable dynamic configuration modification on the dialogue side

DigitalHumanConfig

Digital human configuration

Used by actions: ModifyApp.

Name Type Required Description
AssetKey String Yes Digital human avatar asset id
Avatar String Yes Digital human image
Name String Yes Digital human avatar name
PreviewUrl String Yes Preview address of the digital human

Distribution

Reply type distribution item

Used by actions: DescribeAppStatisticsOverview.

Name Type Required Description
CallCount String No

Count of calls for this reply method

Percentage Float No

Percentage of this reply method in the total number of calls (percentage, 0–100, rounded to two decimal places; all 0 when no data is available, and the sum of all items is 100 when there is data)

ReplyName String No

Reply method name (internationalized according to the request language; falls back to the Enumeration Name of reply_method when i18n is missing)

Document external link information

Used by actions: ModifyDocList.

Name Type Required Description
ExternalUrl String No

External URL

ReplaceOriginEnabled Boolean No

Whether to replace the original display

DocRetrievalConfig

Document search configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Confidence Float No

Confidence threshold

Enabled Boolean No

Whether to enable

TopN Integer No

Return the top N entries

DocSwitch

Document switch configuration

Used by actions: ModifyDocList.

Name Type Required Description
DownloadEnabled Boolean No

Whether it is downloadable

ReferEnabled Boolean No

Whether to show in the reference

DuplexBilling

DuplexBilling

Used by actions: CreatePlugin.

Name Type Required Description
BillingUnit Integer No
Enumeration item Enumeration value Description
UNKNOW 0
TOKEN 1 By token
PAGE_COUNT 2 By page number
TIMES 3 By count
TIMES_THOUSAND 4 By thousand counts
SECOND 5 By duration
CHARACTER 6 By number of characters
CHARACTER_THOUSAND 7 By thousand characters
SHEET 8 By sheet
NUMBER 9 By count
InputCashPrice Float No

Input cash price

Unit: CNY

InputPuPrice Float No

Input PU price

Unit: pu

OutputCashPrice Float No

Output cash price

Unit: CNY

OutputPuPrice Float No

Output PU price

Unit: pu

ESConfig

ES configuration

Used by actions: CreateKB, ModifyKB.

Name Type Required Description
CanModify Boolean No

Whether storage method modification is supported

EncryptedPassword String No

ES password (encrypted)

InstanceId String No

ES cluster ID

StorageType Integer No

Storage type: 1=default storage, 2=custom storage

Enumeration itemEnumeration valueDescription
ES_STORAGE_TYPE_UNKNOWN0
ES_STORAGE_TYPE_DEFAULT1Default storage
ES_STORAGE_TYPE_CUSTOM2Custom storage

UserName String No

ES userName

EffectivePeriod

Validity period.

Used by actions: CreateQAList, ModifyDocList, ModifyQAList.

Name Type Required Description
EndTime String No

Validity end time (Unix seconds. 0 indicates permanent validity).

StartTime String No

Validity start time (Unix seconds)

ExecuteConfig

ExecuteConfig

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
PromptConfig AppTriggerPromptExecuteConfig No

Prompt configuration

WorkflowConfig AppTriggerWorkflowExecuteConfig No

Workflow configuration.

ExpirationAwareness

Timeliness retrieval enhancement configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Enabled Boolean No

Whether to enable timeliness retrieval. Once enabled, retrieval results will be sorted based on the validity time of the knowledge

ExpirationPolicy

Expiration policy (validity time and behavior after the validity period expires)

Used by actions: CreateQAList, DescribeQA, DescribeQASummaryList, ModifyDocList, ModifyQA, ModifyQAList.

Name Type Required Description
EffectivePeriod EffectivePeriod No

Validity time

ExpireBehavior Integer No

Behavior after the validity period expires: 1=NOT_RETRIEVABLE cannot be retrieved, 2=RETRIEVABLE can still be retrieved; meaningless for permanent validity

Enumeration itemEnumeration valueDescription
EXPIRE_BEHAVIOR_UNKNOWN0Unspecified (server uses the default process)
EXPIRE_BEHAVIOR_NOT_RETRIEVABLE1Cannot be retrieved (removed upon expiration)
EXPIRE_BEHAVIOR_RETRIEVABLE2Can still be retrieved (not removed upon expiration, only the validity period is tagged)

FieldMask

FieldMask

Used by actions: DescribeApp, DescribePlugin, ModifyAgent, ModifyApp, ModifyAppTrigger, ModifyKB, ModifyLabel, ModifyQA, ModifySpace.

Name Type Required Description
Paths Array of String No

Parameter name

Parameter format: path of the specified field to get

FileParseModel

Document parsing model parameters

Used by actions: ModifyApp.

Name Type Required Description
Alias String Yes Model alias
Description String Yes Model description
EnhancementMode String Yes Enhanced mode
ModelId String Yes Unique ID of a model
ModelProviderType String Yes Model type
EnableFormulaEnhancement Boolean No Whether to enable formula enhancement
EnableLLMEnhancement Boolean No Whether to enable LLM enhancement
OutputHtmlTable Boolean No Whether to output an HTML table
SupportedFileList Array of SupportedFileType No Supported file type list

FileVolumeMount

Cloud disk mounting configuration in the application sandbox.

Used by actions: DescribeApp, ModifyApp.

Name Type Required Description
AccessMode String Yes

Access mode: RO=read-only, RW=read-write; required. Only RW can be used when mounting to /workdir.

MountPath String Yes

Absolute mount directory in the sandbox; /workdir can be mounted at most once and only RW can be used.

VolumeId String Yes

Cloud disk identification

MountId String No

Server-side generated mount flag. Reserved for modification, optional for new additions.

RelativePath String No

Path relative to the root directory of cloud disk data; an empty string indicates mounting the entire data root directory.

VolumeName String No

Cloud disk name. It is supplemented by the server only when querying the application configuration and ignored during modification. It is empty when it cannot be obtained and does not impact the mount configuration.

Filter

Universal list filter criteria (multiple Filters are in an AND relationship, while multiple value_list elements within the same Filter are in an OR relationship; for BETWEEN, value_list must contain exactly 2 elements, representing an inclusive interval [start, end])

Used by actions: DescribeAccountList, DescribeAgentReleasePreviewList, DescribeAgentSummaryList, DescribeAppStatisticsOverview, DescribeAppSummaryList, DescribeAppTriggerRunLogList, DescribeAppTriggerSummaryList, DescribeAuditLogList, DescribeCategoryList, DescribeConcurrencyLimitDetailList, DescribeConflictQASummaryList, DescribeLabel, DescribeLabelSummaryList, DescribeModelList, DescribePluginSummaryList, DescribeQASummaryList, DescribeSkillSummaryList, DescribeUsageSummaryList, DescribeVariableList, ExportQA.

Name Type Required Description
Name String No Filter field name
Operator Integer No Operator, default IN (backward compatibility)
Enumeration itemEnumeration valueDescription
FILTER_OPERATOR_IN0Belongs to value_list (default value, backward compatibility; value_list cannot be empty)
FILTER_OPERATOR_NOT_IN1Does not belong to value_list (value_list cannot be empty)
FILTER_OPERATOR_BETWEEN2Between (inclusive interval [start, end]; value_list must contain exactly 2 elements, one of which can be empty to indicate a unilateral open interval)
ValueList Array of String No Filter value array

FinalRerankConfig

Final rerank configuration

Used by actions: SearchKnowledge.

Name Type Required Description
ModelName String No

Model name

GenerateModel

Generative model configuration

Used by actions: ModifyApp.

Name Type Required Description
Model ModelDetailInfo Yes Generative model

GraphRAG

GraphRAG configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Enabled Boolean No

Whether to enable

Identity

Common identity information (supports two forms: numeric ID and string ID)

Used by actions: CreateRelease, CreateSkillShare, DescribeApp, DescribeLatestRelease, DescribeReleaseSummary.

Name Type Required Description
Description String No Description
Id String No Digital ID
Name String No Name
StrId String No String ID

InputBoxConfig

Input box configuration

Used by actions: ModifyApp.

Name Type Required Description
InputBoxButtons Array of Integer No Input box buttons: 1: Upload image, 2: Upload documents, 3: Tencent Docs, 4: Online search

IntentAchievementInfo

Intent attainment information

Used by actions: ModifyApp.

Name Type Required Description
Description String Yes Description
Name String Yes Name

IntervalSchedule

IntervalSchedule

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
StartAt String No Start time.
Unit Integer No Enumeration values:
| Enumeration value | uint |
| --- | --- |
| INTERVAL_UNIT_UNSPECIFIED | 0 |
| INTERVAL_UNIT_HOUR | 1 |
| INTERVAL_UNIT_DAY | 2 |
Value Integer No Value

KBCategory

Knowledge base classification info (including metadata configuration)

Used by actions: DescribeCategoryList.

Name Type Required Description
CanAdd Boolean No

Whether it can be added

CanDelete Boolean No

Whether it is deletable

CanEdit Boolean No

Whether it is editable

CategoryId String No

Category ID

ChildList Array of KBCategory No

Subcategory list.

IsLeaf Boolean No

Is leaf node (no subcategory)

ItemCount Integer No

The number of category objects

MetaValue MetaValue No

Metadata configuration (configuration message when this category is set as metadata)

Name String No

Category name

KBModelConfig

Model configuration of the knowledge base

Used by actions: CreateKB, ModifyKB.

Name Type Required Description
EmbeddingModel String No

Embedding model

QaExtractModel String No

QA extraction model

SchemaModel String No

Schema generative model

KBModifyExtendFields

Modify the Extension Field of the knowledge base (used to trigger special operations)

Used by actions: ModifyKB.

Name Type Required Description
Action Integer No

Scaling operation: 1=trigger recovery from exceeded state

Enumeration itemEnumeration valueDescription
KB_EXTENDED_ACTION_UNKNOWN0
KB_EXTENDED_ACTION_RESUME_EXCEEDED1Trigger recovery from exceeded state (restore the knowledge base from exceeded status to normal status)

KBRetrievalConfig

Search configuration of each knowledge base

Used by actions: SearchKnowledge.

Name Type Required Description
DbRetrievalConfig DBRetrievalConfig No

Database search configuration

DocRetrievalConfig DocRetrievalConfig No

Document retrieval configuration.

KbId String No

Knowledge base ID

OptionConfig RetrievalOption No

Retrieval optional configuration

QaRetrievalConfig QARetrievalConfig No

QA search configuration

RerankConfig RerankConfig No

ReRank configuration

SearchFilterConfig SearchFilterConfig No

Search filter configuration

StrategyType Integer No

Retrieval strategy: 1=hybrid, 2=semantic, 3=keyword, 4=none

Enumeration itemEnumeration valueDescription
SEARCH_STRATEGY_TYPE_UNKNOWN0
SEARCH_STRATEGY_TYPE_MIXING1Hybrid retrieval
SEARCH_STRATEGY_TYPE_SEMANTIC2Semantic retrieval
SEARCH_STRATEGY_TYPE_KEYWORD3Keyword retrieval
SEARCH_STRATEGY_TYPE_NONE4No semantic/vector retrieval

TextToSqlModel ModelDetailInfo No

Text2SQL model

KBSpec

Collection of writable attributes of the knowledge base (used in conjunction with update_mask)

Used by actions: CreateKB, ModifyKB.

Name Type Required Description
Description String No

Description.

EsConfig ESConfig No

ES configuration

ModelConfig KBModelConfig No

Model configuration

Name String No

Knowledge base name

OwnerId String No

Owner ID

KVPair

Common key-value pair

Used by actions: SearchKnowledge.

Name Type Required Description
Key String No Key
Value String No Value

KnowledgeResult

A single retrieval result

Used by actions: SearchKnowledge.

Name Type Required Description
Confidence Float No

Confidence degree

KnowledgeType Integer No

Hit knowledge type: 1=QA, 2=document fragment, 3=database, 4=map

Enumeration itemEnumeration valueDescription
KNOWLEDGE_SOURCE_TYPE_UNKNOWN0
KNOWLEDGE_SOURCE_TYPE_QA1QA
KNOWLEDGE_SOURCE_TYPE_DOC2Document fragment
KNOWLEDGE_SOURCE_TYPE_DB3Database
KNOWLEDGE_SOURCE_TYPE_GRAPH4Map

RecallTypeList Array of Integer No

Recall type list

ResultPayload SearchResultPayload No

Result payload

ResultType Integer No

Result type

Enumeration itemEnumeration valueDescription
SEARCH_RESULT_TYPE_UNKNOWN0
SEARCH_RESULT_TYPE_RETRIEVAL1Standard search result
SEARCH_RESULT_TYPE_TEXT_TO_SQL2text2sql result
SEARCH_RESULT_TYPE_IMAGE_SEARCH_IMAGE3
SEARCH_RESULT_TYPE_TEXT_SEARCH_IMAGE4

SimilarQuestionExtra SimilarQuestionExtra No

Additional information for similar questions.

SnippetProfile KnowledgeSnippetProfile No

Basic information of knowledge fragment

SourceInfo KnowledgeSource No

Knowledge source information

KnowledgeScope

Effective scope of knowledge

Used by actions: DescribeQA, DescribeQASummaryList.

Name Type Required Description
EffectiveDomain Integer No

Effective scope

Enumeration itemEnumeration valueDescription
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1Disabled
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2Development domain only
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3Release domain only
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4Global

LabelRefList Array of LabelRef No

Applicable scope (tag condition).

KnowledgeSnippetProfile

Basic information of knowledge fragment

Used by actions: SearchKnowledge.

Name Type Required Description
Content String No

Content

DocId String No

Associated document ID

DocName String No

Document name

KbId String No

Knowledge base ID

KnowledgeId String No

Knowledge ID

Question String No

Query

Title String No

Document title

KnowledgeSource

Knowledge source information

Used by actions: SearchKnowledge.

Name Type Required Description
IsBigData Boolean No

Whether it is big data

IsShared Boolean No

Whether it is a shared knowledge base

KbName String No

Knowledge base name

LabelModifyFields

Collection of modifiable tag fields (used in conjunction with update_mask)

Used by actions: ModifyLabel.

Name Type Required Description
Name String No

Tag name.

TermModifyList Array of LabelTermModifyItem No

List of incremental modifications to standard words (add/modify/delete)

LabelRef

Tag reference (for output parameters)

Used by actions: DescribeQA, DescribeQASummaryList.

Name Type Required Description
LabelId String No

Tag ID.

LabelName String No

Tag name.

LabelTermIdList Array of String No

Tag standard term ID list.

LabelTermList Array of String No

Tag standard word list

LabelRefIdentity

Tag reference identifier (input parameter)

Used by actions: CreateQAList, ModifyDocList, ModifyQA, ModifyQAList.

Name Type Required Description
LabelId String No

Tag ID

LabelTermIdList Array of String No

Tag standard term ID list

LabelRefIdentityList

Tag references list

Used by actions: ModifyDocList, ModifyQAList.

Name Type Required Description
ItemList Array of LabelRefIdentity No

Tag references list.

LabelSummary

Tag abstract

Used by actions: DescribeLabel, DescribeLabelSummaryList.

Name Type Required Description
LabelId String No

Tag ID.

MetaValue MetaValue No

Metadata configuration (configuration message when the tag is set to metadata)

Name String No

Tag name.

RefCount Integer No

Number of resources referring to the tag

TermList Array of LabelTerm No

Tag value (standard word + synonym list)

TermTotalCount Integer No

Total number of tag values.

LabelTerm

Standard word (one tag value)

Used by actions: CreateLabel, DescribeLabel, DescribeLabelSummaryList, ModifyLabel.

Name Type Required Description
SynonymList Array of String No

Synonym list

Term String No

Standard words

TermId String No

Standard term ID (generated by the backend, not passed in upon creation)

LabelTermCheckResult

Standard word check item

Used by actions: CheckLabel.

Name Type Required Description
CheckResult CheckResult No Check results
Term String No Standard words to be checked
TermId String No Return the corresponding standard term ID if exists.

LabelTermModifyItem

Modified items of tag standard words (incremental update)

Used by actions: ModifyLabel.

Name Type Required Description
ModifyAction Integer Yes

Operation type (not allowed to be 0. Value: 1=create, 2=modify, 3=delete)

Enumeration itemEnumeration valueDescription
MODIFY_ACTION_UNKNOWN0
MODIFY_ACTION_CREATE1Create
MODIFY_ACTION_UPDATE2Modify
MODIFY_ACTION_DELETE3Delete

SynonymList Array of String No

Synonym list (pass the complete synonym collection during CREATE and UPDATE, overriding update)

Term String No

Standard word (required for CREATE and UPDATE, can be left blank for DELETE)

TermId String No

Standard term ID (required for UPDATE and DELETE; leave blank for CREATE, generated by the backend)

MCPPluginConfig

MCP plug-in configuration message

Used by actions: CreatePlugin.

Name Type Required Description
ExternalMCPServerUrl String No

MCP plug-in public access address

MCPServerUrl String No

MCP server address

MCPTransport Integer No

MCP transmission type: SSE/Streamable
Enumeration values:
| uint | Description |
| --- | --- |
| 0 | SSE + HTTP mode |
| 1 | Streamable HTTP mode |

PluginHeader Array of PluginParam No

header parameters of the MCP plug-in

PluginQuery Array of PluginParam No

query parameter of the MCP plug-in

SSEReadTimeout Integer No

SSE persistent connection timeout period, in seconds

Timeout Integer No

Request timeout period, in seconds

AuthConfig AuthConfig No

Authorization information.

SupportsApps Boolean No

Whether the interactive interface (MCP Apps) and plug-in-level tags are supported. Default false

MCPToolConfig

MCPToolConfig

Used by actions: CreatePlugin.

Name Type Required Description
Inputs Array of RequestParam No

Input parameter

Outputs Array of ResponseParam No

Output parameters

Meta MCPToolMeta No

Tool meta information

SupportsApps Boolean No

Whether the interactive interface (MCP Apps) and plug-in-level tags are supported. Default value: false

MCPToolMeta

_meta corresponding to the MCP protocol tool, carrying UI meta information for MCP Apps tools (only resourceUri is consumed in the current period)

Used by actions: CreatePlugin.

Name Type Required Description
Ui MCPToolUIMeta No

UI extended meta information of the tool, corresponding to _meta.UI in the MCP protocol, declaring the interactive UI resource (ResourceUri) associated with the tool and the caller Visibility. Returned only when the tool supports MCP Apps or declares Visibility; this field is empty for text tools. For details, see the MCPToolUIMeta structure definition.

MCPToolUIMeta

Corresponds to the MCP protocol _meta.ui, defining the meta information of the interactive interface for MCP Apps tools (this period only consumes resourceUri and visibility).

Used by actions: CreatePlugin.

Name Type Required Description
ResourceUri String No

Associated UI resource URI in UI:// scheme, format: UI://<plug-in flag>/<resource name>-<version>. This field is the entry to the interactive UI of MCP Apps. If not empty, it means the tool supports Apps (shown as "text + interactive UI"). If empty, it is a plain text tool. It is automatically identified and filled based on the tool sync result and does not support manual editing.

Visibility Array of String No

Visibility declaration for tool callers. Value range: model (callable by models), app (callable by UI). Multiple selections allowed, for example ["model","app"]. Independent of ResourceUri (SEP-1865) and can exist independently. For example, a backend app-only tool is ["app"]. When ResourceUri is non-empty and this field is not specified, it is normalized to ["model","app"] by default. Existing non-Apps tools remain empty.

Enumeration values:

  • model: Supports model
  • app: Supports app

ManualOnlySchedule

ManualOnlySchedule

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
Enabled Boolean No Enable

MetaValue

Metadata value

Used by actions: DescribeCategoryList, DescribeLabel, DescribeLabelSummaryList.

Name Type Required Description
Name String No

Metadata value name (for display only).

RefAll Boolean No

Whether to refer to all values of this type (when true, ref_value_id should be 0)

RefValueId String No

Business ID referenced by metadata (property ID, category ID, etc.); this field should be 0 when ref_all=true

Scene Integer No

Metadata usage scenario: 1=retrieve only, 2=both retrieve and generate

Enumeration itemEnumeration valueDescription
META_SCENE_UNKNOWN0Unknown
META_SCENE_SEARCH_ONLY1Retrieve only
META_SCENE_ALL2Both retrieve and generate

ValueType Integer No

Metadata value type: 1=property tag, 2=document classification, 3=QA classification

Enumeration itemEnumeration valueDescription
META_VALUE_TYPE_UNKNOWN0Unknown
META_VALUE_TYPE_TAG1Property tag
META_VALUE_TYPE_DOC_CATEGORY2Document classification
META_VALUE_TYPE_QA_CATEGORY3QA classification

Model

Model complete information

Used by actions: DescribeModelList.

Name Type Description
BadgeList Array of ModelBadge

Model badge list

DeveloperInfo ModelDeveloperBasic

Model author information

LimitInfo ModelLimit

Model restrictive information

ModelBasic ModelBasic

Model basic information

ParameterList Array of ModelParameter

Model hyperparameter configuration

PropertyList Array of ModelProperty

Model attribute configuration

ProviderInfo ModelProviderBasic

Model provider info

StatusInfo ModelStatus

Model status information

TagList Array of String

Model tag list

ModelBadge

Model badge (external, visible on the user end): ALL copywriting has been rendered as final displayed content, without exposing template parameters

Used by actions: DescribeModelList.

Name Type Description
Text String

Display copy (rendered as final copy)

Theme Integer

Style theme

Enumeration itemEnumeration valueDescription
MODEL_BADGE_THEME_UNSPECIFIED0Unspecified
MODEL_BADGE_THEME_INFO1Info (blue)
MODEL_BADGE_THEME_SUCCESS2Success (green)
MODEL_BADGE_THEME_WARNING3Warning (orange)
MODEL_BADGE_THEME_DANGER4Danger (red)
Tips String

tooltip copywriting (rendered as final copywriting). If it is empty, it is not displayed.

Type Integer

Badge type

Enumeration itemEnumeration valueDescription
MODEL_BADGE_TYPE_UNSPECIFIED0Unspecified
MODEL_BADGE_TYPE_FREE_TRIAL1Limited-time free
MODEL_BADGE_TYPE_DEPRECATING2About to go offline
MODEL_BADGE_TYPE_NEW3New model
MODEL_BADGE_TYPE_HOT4Popular

ModelBasic

Basic model info (deprecated, please use ModelProfile)

Used by actions: DescribeModelList.

Name Type Description
Description String

Model description

IconUrl String

Model icon address

ModelId String

Model ID

ModelType Integer

Model type

Enumeration itemEnumeration valueDescription
MODEL_TYPE_UNSPECIFIED0Unspecified
MODEL_TYPE_LLM1LLM model
MODEL_TYPE_RERANK2Rerank model
MODEL_TYPE_EMBEDDING3Embedding model
MODEL_TYPE_FILE_PARSE4Document parsing model
Name String

Model name

ModelDetailInfo

Model details

Used by actions: ModifyApp, SearchKnowledge.

Name Type Required Description
Alias String No Model alias
HistoryLimit Integer No Limit on number of historical conversations
ModelId String No Unique model ID
ModelParams ModelParams No Model parameters

ModelDeveloperBasic

Basic model author info (deprecated)

Used by actions: DescribeModelList.

Name Type Required Description
Alias String No

Author alias.

Name String No

Author flag

ModelLimit

Model restrictive information

Used by actions: DescribeModelList.

Name Type Description
ContextLengthDescription String

Model context length display copy (for example, 128K, 1000K)

InputLengthLimit Integer

Character limit for model dialog box input length

MaxInputTokensDescription String

Maximum input Tokens display copy (for example, 960k, formatted on the server, empty string if not configured)

MaxOutputTokensDescription String

Display copy for the maximum output Tokens (for example, 64k, formatted on the server, empty string if not configured)

PromptLengthLimit Integer

Model prompt content length character limit

ModelParameter

Model hyperparameter

Used by actions: DescribeModelList.

Name Type Description
DefaultValue String

Default value.

EnumValueList Array of String

Available Option List

MaxValue Float

Maximum value (valid only for numerical type).

MinValue Float

Minimum value (valid only for numerical types).

Name String

Hyperparameter name

Type Integer

Hyperparameter type. 1-floating-point number, 2-integer, 3-string

ModelParams

Model parameters

Used by actions: CreateAgent, DescribeAgentDetail, ModifyAgent, ModifyApp, SearchKnowledge.

Name Type Required Description
DeepThinking String No

Whether to enable deep thinking

FrequencyPenalty Float No

Frequency penalty

MaxTokens Integer No

Maximum output length

PresencePenalty Float No

Existence penalty

ReasoningEffort String No

Deep thinking effect

RepetitionPenalty Float No

Repetition penalty

ReplyFormat String No

Output format (text, json_object)

Seed Integer No

Random seed

StopSequenceList Array of String No

Stop sequence

Temperature Float No

Temperature

TopP Float No

top_p

TopK Integer No

top_k

ModelProperty

Model attributes (supported workflow types/AI call types/want to close model parameters/whether deep thinking is supported/whether limited-time free/whether default model)

Used by actions: DescribeModelList.

Name Type Description
Name String

Property name

Value String

Attribute value.

ModelProviderBasic

Basic model provider info (deprecated, please use ModelProviderProfile)

Used by actions: DescribeModelList.

Name Type Description
Alias String

Model provider alias

Name String

Model provider name

ProviderType Integer

Model provider type

Enumeration itemEnumeration valueDescription
MODEL_PROVIDER_TYPE_UNSPECIFIED0Unspecified
MODEL_PROVIDER_TYPE_SELF1Self-owned provider
MODEL_PROVIDER_TYPE_CUSTOM2Custom model provider
MODEL_PROVIDER_TYPE_THIRD3Third-party model provider

ModelStatus

Model status

Used by actions: DescribeModelList.

Name Type Description
Concurrency Integer

Number of exclusive concurrencies

IsExclusive Boolean

Whether it is exclusive concurrency

IsExperienceSupported Boolean

Whether direct experience in the intelligent workbench is supported (model plaza details page: dynamically determined based on space_id; when false, the frontend disables the "experience now" button)

ResourceStatus Integer

Resource status

Enumeration itemEnumeration valueDescription
RESOURCE_STATUS_UNSPECIFIED0Not specified
RESOURCE_STATUS_AVAILABLE1Resource available
RESOURCE_STATUS_EXHAUSTED2Resource exhausted
RpmLimit String

RPM call cap (current account dimension: use the configured value if available; otherwise, take default. 0 means not obtained)

TpmLimit String

TPM call upper limit (at the current account level: use the configured value if available; otherwise, take default. 0 means failed to obtain)

ModelUsageSummary

Aggregated details of model resource usage (exclusive to MODEL domain)

Used by actions: DescribeUsageSummaryList.

Name Type Required Description
CallCount Float No

Number of calls (top-level count of API calls)

IsDefaultKB Boolean No

Whether it is the default knowledge base

ModelName String No

Model name, flag indicating the AI model used

ResourceConsumptionList Array of ResourceConsumption No

MODEL domain consumption measurement list (authoritative field): lists each measurement category by unit + label. When unit=TOKEN, label is case-sensitive for Token subcategories (input/output/avg_/cache_), with an empty label indicating total_tokens; unit=PAGE_COUNT refers to the model's consumed page count

ConsumptionPU Float No

Total model PU consumption (sum of PU consumption within the aggregate dimension)

MsgRecordCategory

MsgRecordCategory

Used by actions: DescribeMsgRecordCategoryList.

Name Type Required Description
CategoryId String No

Business ID of the category

Children Array of MsgRecordCategory No

Subcategory list, tree nesting

Name String No

Category name

Permission CategoryPermission No

Operation permissions of the current user on this category.

TotalCount String No

The number of message records in this category

MultiAgentConfig

Multi-agent configuration

Used by actions: ModifyApp.

Name Type Required Description
AgentCollaboration AgentCollaborationConfig Yes Agent collaboration configuration

MultiModalQAModel

Multimodal QA model configuration

Used by actions: ModifyApp.

Name Type Required Description
Model ModelDetailInfo Yes Model configuration

MultiModalUnderstandingModel

Multimodal understanding model configuration

Used by actions: ModifyApp.

Name Type Required Description
Model ModelDetailInfo Yes Model configuration

NodeRun

Basic information of node operation

Used by actions: DescribeNodeRunDetail, DescribeWorkflowRun.

Name Type Required Description
NodeRunId String No ID of the node operation
NodeId String No Node ID.
WorkflowRunId String No ID of the workflow running instance
NodeName String No Node name.
NodeType Integer No Node type.
1: Start node
2: Parameter extraction node
3: Large model node
4: Knowledge Q&A node
5: Knowledge retrieval node
6: Tag extraction node
7: Code execution node
8: Tool node
9: Logic judgment node
10: Reply node
11: Tab node
12: Loop node
13: Intent recognition node
14: Workflow node
15: Plug-in node
16: End node
17: Variable aggregate node data
18: Batch processing node
19: Message Queue node
20: Database node
21: Variable assignment node data
22: Variable conversion node data
23: Agent node
24: Annotation node
25: File collection node
26: Text collection node
27: Widget node
Status Integer No Running state. 1: initial status; 2: running; 3: operation successful; 4: operation failure; 5: canceled
FailMessage String No Error message
TotalCostMs Integer No Total time consumed (ms)
TotalTokens Integer No Total number of tokens consumed
FailCode String No Error code.
BranchIndexList Array of Integer No List of branch indexes

NodeRunContent

Node operation content

Used by actions: DescribeNodeRunDetail.

Name Type Required Description
Input String No Input variable information
Output String No Output variable information
OriginalOutput String No Original output information. Only partial nodes have a value, such as tool nodes and code nodes.
InputRef String No URLs of the complete node Input content. (This field has a value only when the Input content exceeds the limit.)
OutputRef String No URLs of the complete node Output. This field has a value only when the Output exceeds the limit.
OriginalOutputRef String No URLs of the complete original output content of the task. (This field has a value only when the TaskOutput content exceeds the limit.)

NodeRunDetail

Workflow node running details

Used by actions: DescribeNodeRunDetail.

Name Type Required Description
NodeRun NodeRun No

Node running information

NodeRunContent NodeRunContent No

Node operation content.

NodeRunExecution NodeRunExecution No

Node operation process

NodeRunLog NodeRunLog No

Node operation logs

StatisticList Array of Statistic No

Statistical information.

NodeRunExecution

NodeRunExecution

Used by actions: DescribeNodeRunDetail.

Name Type Required Description
BatchRunSummary BatchRunSummary No

Batch operation summary

EndTime String No

End time (timestamp in milliseconds).

StartTime String No

Start time (timestamp in milliseconds)

NodeRunLog

NodeRunLog

Used by actions: DescribeNodeRunDetail.

Name Type Required Description
Log String No

Logs of node.

LogRef String No

URLs of the complete content of logs of node (has a value only when the Log content exceeds the limit)

OAuthConfig

OAuth 2.0 authorization information

Used by actions: CreatePlugin.

Name Type Required Description
AuthorizationUrl String No url address of the OAuth service provider authorization page
ClientId String No Client ID
ClientSecret String No Client Key
ScopeList Array of String No Data scope for the authorization request
TokenUrl String No url address for obtaining the access token

OnceSchedule

OnceSchedule

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
FireTime String No Trigger time.

OperationResult

Common operation result item

Used by actions: CreateQAList, DeleteDocList, DeleteLabelList, DeleteQAList, ModifyDocList, ModifyQAList.

Name Type Required Description
Id String No

Resource ID.

Reason String No

Failure reason (populated when succeeded=false)

Succeeded Boolean No

Whether it is successful

Operator

Common operator information

Used by actions: DescribeQA, DescribeQASummaryList.

Name Type Required Description
UserId String No User ID.
UserName String No Username

PlatformUsageSummary

Aggregated details of platform resource usage (exclusive to PLATFORM domain)

Used by actions: DescribeUsageSummaryList.

Name Type Required Description
ResourceConsumptionList Array of ResourceConsumption No

PLATFORM domain consumption measurement list (authoritative field): list each measurement type by unit + label, where label is the PlatformBizType enumeration name string; typical examples include unit=TIMES + label=PLATFORM_BIZ_TYPE_SECURITY_AUDIT/WEB_SEARCH/OPEN_CLAW/APP_INVOKE, unit=ITEM + label=PLATFORM_BIZ_TYPE_LONG_TERM_MEMORY

Plugin

Plugin details

Used by actions: DescribePlugin.

Name Type Required Description
Config PluginConfig No Plug-in configuration
CreateTime String No Creation time, Unix Timestamp
Operation PluginOperation No Plug-in operation management information
PluginId String No Plugin ID
PluginVersion Integer No Plugin version number
Profile PluginProfile No Basic plug-in information.
Statistics PluginStatistics No Plug-in statistical information
Status Integer No

Plug-in status. 1: available, 2: unavailable

Enumeration values:

  • 1: available
  • 2: unavailable
ToolList Array of Tool No Tool list
UpdateTime String No Update time, Unix timestamp
UserState PluginUserState No Plugin status information by user dimension

PluginConfig

Plug-in configuration

Used by actions: CreatePlugin, DescribePlugin, DescribePluginSummaryList.

Name Type Required Description
ApiPluginConfig ApiPluginConfig No API plug-in configuration
AppPluginConfig AppPluginConfig No App plugin configuration
MCPPluginConfig MCPPluginConfig No mcp plug-in configuration

PluginOperation

PluginOperation

Used by actions: DescribePlugin, DescribePluginSummaryList.

Name Type Required Description
AllowExternalAccess Boolean No Whether external calls are allowed
BillingType Integer No

Billing type.

Valid values:

  • 0: free
  • 1: open beta
  • 2: official fees
CategoryKey String No Plug-in category identifier
Introduction String No Plug-in overview
IsRecommended Boolean No Whether it is a selection

PluginParam

Parameter information of the MCP plug-in.

Used by actions: CreatePlugin.

Name Type Required Description
IsGlobalHidden Boolean No Whether to hide parameter configuration
IsRequired Boolean No Whether the parameter is required
Name String No Parameter name.
Value String No Parameter value.

PluginProfile

PluginProfile

Used by actions: CreatePlugin, DescribePlugin, DescribePluginSummaryList.

Name Type Required Description
Author String No Plug-in author
Description String No Plugin description
IconUrl String No Plug-in icon url
Name String No Plugin name
PluginClass Integer No

Plug-in product type

Enumeration values:

  • 0: ordinary plug-in
  • 1: connector plug-in
PluginKind Integer No

Plugin type

Enumeration values:

  • 0: API
  • 1: Code
  • 2: MCP
  • 3: Application
PluginSource Integer No

Plug-in source

Enumeration values:

  • 0: custom plugin
  • 1: official plug-in
  • 2: third-party plugin

PluginStatistics

PluginStatistics

Used by actions: DescribePlugin, DescribePluginSummaryList.

Name Type Required Description
CallCount Integer No Plug-in calling volume
ToolCount Integer No Number of tools

PluginSummary

Plug-in summary information (for the plug-in list)

Used by actions: DescribePluginSummaryList.

Name Type Required Description
Config PluginConfig No

Plug-in configuration message.

IsShared Boolean No

Whether shared is configured

Operation PluginOperation No

Plugin operation management information.

PluginId String No

plugin_id

Profile PluginProfile No

Basic information of the plug-in.

SpaceId String No

Space ID that the plug-in belongs to; empty for built-in plugins

Statistics PluginStatistics No

Plugin statistical information.

Status Integer No

Plug-in status. 1: available, 2: unavailable

Enumeration values:

  • 1: available
  • 2: unavailable
ToolList Array of ToolSummary No

Tool information

UserState PluginUserState No

Plugin status information by user dimension

UpdateTime String No

Update time, Unix timestamp

Unit: seconds

PluginUsageSummary

Aggregated details of plug-in resource usage (exclusive to the PLUGIN domain)

Used by actions: DescribeUsageSummaryList.

Name Type Required Description
CallCount Float No

Number of calls (top-level count of API calls)

ResourceConsumptionList Array of ResourceConsumption No

Consumption measurement list for the PLUGIN domain (authoritative field): lists each measurement category by unit + label. When unit=TOKEN, label is case-sensitive for Token subcategories (input/output/avg_*). Being empty indicates total_tokens

PluginUserState

PluginUserState

Used by actions: DescribePlugin, DescribePluginSummaryList.

Name Type Required Description
IsFavorite Boolean No Whether the plug-in has been bookmarked
IsInWhiteList Boolean No Whether it is in the plug-in allowlist
WhiteListType Integer No

Allowlist type, used to represent whether the current user can use this plug-in directly.

Enumeration values:

  • 0: Not on the allowlist, fully available
  • 1: Current user in allowlist
  • 2: Current user not in allowlist, submit an application

PortalShareConfig

PortalShareConfig

Used by actions: CreateRelease, DescribeApp, DescribeLatestRelease, DescribeReleaseSummary.

Name Type Required Description
Enabled Boolean No

Business shared switch

PromptRewriteModel

Prompt rewrite configuration

Used by actions: ModifyApp.

Name Type Required Description
Model ModelDetailInfo Yes Model configuration

QACreateSpec

QA create specification (one-time input of non-persistent data)

Used by actions: CreateQAList.

Name Type Required Description
Question String Yes

Query

Answer String No

Answer

CategoryId String No

Category ID

DocId String No

Associated document ID

EffectiveDomain Integer No

Knowledge effective scope

Enumeration itemEnumeration valueDescription
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1Disabled
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2Development domain only
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3Release domain only
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4Global

ExpirationPolicy ExpirationPolicy No

Expiration policy (validity time and behavior after the validity period expires)

LabelRefList Array of LabelRefIdentity No

Applicable scope (tag condition)

QuestionDescription String No

Issue description

SimilarQuestionList Array of String No

Similar question list

QALifecycle

QA lifecycle information

Used by actions: DescribeQA, DescribeQASummaryList.

Name Type Required Description
CreateTime String No

Creation time (Unix seconds).

ExpirationPolicy ExpirationPolicy No

Expiration policy (validity time and behavior after the validity period expires)

Status Integer No

Status: 1=pending verification, 2=not adopted, 3=import failed, 4=under review, 5=review failed, 6=Learning, 7=learn failed, 8=import completed, 9=expired, 10=quota invalid, 11=quota recovering, 12=manual appeal in progress, 13=manual appeal failed

Enumeration itemEnumeration valueDescription
QA_STATUS_UNKNOWN0
QA_STATUS_PENDING_VERIFY1Pending verification
QA_STATUS_NOT_ACCEPTED2Not adopted
QA_STATUS_IMPORT_FAIL3Import failed
QA_STATUS_AUDITING4Under review
QA_STATUS_AUDIT_FAIL5Review failed
QA_STATUS_LEARNING6Learning
QA_STATUS_LEARN_FAIL7Learn failed
QA_STATUS_IMPORTED8Import completed
QA_STATUS_EXPIRED9Expired
QA_STATUS_QUOTA_INVALID10Quota invalid
QA_STATUS_QUOTA_RECOVERING11Quota recovering
QA_STATUS_MANUAL_APPEALING12Manual appeal in progress
QA_STATUS_MANUAL_APPEAL_FAIL13Manual appeal failed

StatusDesc String No

Status description.

StatusMessage String No

Status additional information

UpdateTime String No

Update time (Unix seconds).

QAMetadata

QA meta information

Used by actions: DescribeQA, DescribeQASummaryList.

Name Type Required Description
Answer String No

Answer

QaCharCount String No

QA characters

QaSize String No

QA size (byte, including similar questions)

Question String No

Query

RefFieldNameList Array of String No

Metadata reference field name list (for displaying which QA categories and attributes are set as metadata)

QAModifyFields

Collection of modifiable QA fields (used in conjunction with update_mask)

Used by actions: ModifyQA.

Name Type Required Description
Answer String No

Answer

CategoryId String No

Category ID

DocId String No

Associated document ID

EffectiveDomain Integer No

Knowledge application scope

Enumeration itemEnumeration valueDescription
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1Disabled
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2Development domain only
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3Release domain only
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4Global

ExpirationPolicy ExpirationPolicy No

Expiration policy (validity time and behavior after the validity period expires)

IsAccepted Boolean No

Whether to adopt (verification passed)

LabelRefList Array of LabelRefIdentity No

Applicable scope (tag condition).

Question String No

Query

QuestionDescription String No

Problem description

SimilarQuestionList Array of SimilarQuestionModifySpec No

Similar question modification list

QAOperator

QA operator information

Used by actions: DescribeQA, DescribeQASummaryList.

Name Type Required Description
Modifier Operator No

Modifier

Permission QAPermission No

Operation permission

QAPermission

QA operation permission information

Used by actions: DescribeQA, DescribeQASummaryList.

Name Type Required Description
CanAccept Boolean No

Whether verification is supported (adoption/non-adoption).

CanDelete Boolean No

Whether it is deletable.

CanEdit Boolean No

Whether it is editable

QAQuery

QA query condition

Used by actions: DescribeQASummaryList, ExportQA.

Name Type Required Description
Query String No

Query keyword (fuzzy search)

QueryScopeList Array of Integer No

Query scope (fields that query acts on): 1=question, 2=tag or tag value, 3=answer; multiple selections supported, unavailable by default

QARetrievalConfig

QA search configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Confidence Float No

Confidence threshold

Enabled Boolean No

Whether to enable

TopN Integer No

Return the top N entries

QASegmentHighlight

QA fragment highlight info

Used by actions: DescribeQA.

Name Type Required Description
EndPos String No

Highlight end position

StartPos String No

Highlight starting position

QASourceInfo

QA source and associated document information

Used by actions: DescribeQA, DescribeQASummaryList.

Name Type Required Description
DocEffectiveDomain Integer No

Application scope of the associated document

Enumeration itemEnumeration valueDescription
KNOWLEDGE_EFFECTIVE_DOMAIN_UNKNOWN0
KNOWLEDGE_EFFECTIVE_DOMAIN_NONE1Disabled
KNOWLEDGE_EFFECTIVE_DOMAIN_DEV2Development domain only
KNOWLEDGE_EFFECTIVE_DOMAIN_RELEASE3Release domain only
KNOWLEDGE_EFFECTIVE_DOMAIN_ALL4Global

DocId String No

Associated document ID

FileName String No

Associated document name

FileType String No

Associated document type

SourceDesc String No

Source description.

SourceType Integer No

Source type: 1=documentation generation, 2=batch import, 3=manual entry

Enumeration itemEnumeration valueDescription
QA_SOURCE_TYPE_UNKNOWN0
QA_SOURCE_TYPE_DOC1Documentation generation
QA_SOURCE_TYPE_BATCH_IMPORT2Batch import
QA_SOURCE_TYPE_MANUAL3Manual entry

QASummary

QA digest information

Used by actions: DescribeQA, DescribeQASummaryList.

Name Type Required Description
CategoryPath CategoryPath No

Category path (including category ID, category ID path from the root node, and category name path)

KnowledgeScope KnowledgeScope No

Knowledge effective scope

Lifecycle QALifecycle No

Lifecycle information.

Metadata QAMetadata No

Meta information (question/answer/size statistics)

OperatorInfo QAOperator No

Operator information.

QaId String No

QA ID

SimilarQuestion SimilarQuestionStat No

Similar question statistics

SourceInfo QASourceInfo No

Source information.

ReleaseRecord

[Data structure definition] Release record

Used by actions: DescribeReleaseList.

Name Type Required Description
CanExport Boolean Yes Whether it can be exported
CanRollback Boolean Yes Whether it can be rolled back
Description String Yes Release description
FailCount Integer Yes Number of release failures
Reason String Yes Failure cause.
ReleaseId String Yes Release ID
ReleaseVersion String Yes Release version
Status Integer Yes Publishing status. Enumeration values: 1: To be released, 2: Releasing, 3: Released successfully, 4: Release failure, 5: Under review, 6: Review successful, 7: Review failed, 8: Release success callback processing, 9: Release suspended, 10: Appeal under review, 11: Appeal review passed, 12: Appeal review not approved
StatusDescription String Yes Status description.
SuccessCount Integer Yes Number of successful releases
UpdateTime String Yes Update time (Unix timestamp in seconds).
Updater String Yes Releaser

ReleaseSummary

Publish digest information

Used by actions: DescribeLatestRelease, DescribeReleaseSummary.

Name Type Required Description
CreateTime String Yes

Creation time (Unix timestamp, in seconds)

Description String Yes

Release description.

ReleaseId String Yes

Release ID

Status Integer Yes

Released status. Enumeration values: 1: To be released, 2: Releasing, 3: Released successfully, 4: Release failure, 5: Under review, 6: Review successful, 7: Review failed, 8: Callback processing for successful release, 9: Release suspension, 10: Appeal under review, 11: Appeal passed, 12: Appeal not approved

StatusDescription String Yes

Status description.

AppShareAccessControl AppShareAccessControl No

Application sharing access control

ChannelIdList Array of String No

Release channel ID list

CorpShareConfig CorpShareConfig No

Business shared configuration

PortalShareConfig PortalShareConfig No

portal configuration

ReplyContent

Details of the reply content

Used by actions: DescribeWorkflowRun.

Name Type Required Description
Type String No

Message content type
text: text
image: image
file: file
option_cards: tab
custom_params: user-customized business parameter
sandbox: cloud desktop
custom_variables: custom input parameter
web_search: web search content
file_collection: file collection info
widget: widget info
widget_action: client-side widget action information

Text String No

Text content

OptionCardList Array of String No

Tab information

FileCollection ConversationFileCollection No

File collection info

Widget ConversationWidget No

Widget information.

ReplyMessage

Reply message

Used by actions: DescribeWorkflowRun.

Name Type Required Description
ContentList Array of ReplyContent No Message array containing multiple message objects

RequestParam

RequestParam

Used by actions: CreateAgent, CreatePlugin, DescribeAgentDetail, ModifyAgent.

Name Type Required Description
AnyOf Array of RequestParam No

Parameters in types of AnyOf

DefaultValue String No

Default value.

Description String No

Parameter description

IsGlobalHidden Boolean No

Globally hidden and invisible (different from agent_hidden in the Agent scenario). true: globally hidden and invisible; false: visible

IsRequired Boolean No

Required or optional

Name String No

Parameter name

OneOf Array of RequestParam No

Parameters in types of OneOf

SubParams Array of RequestParam No

Sub-parameter, used only when ParamType is OBJECT or ARRAY<>

Type Integer No
Enumeration itemEnumeration valueDescription
PARAM_TYPE_STRING0String
PARAM_TYPE_INT1Integer
PARAM_TYPE_FLOAT2Floating-point number
PARAM_TYPE_BOOL3Boolean value
PARAM_TYPE_OBJECT4Object
PARAM_TYPE_ARRAY_STRING5Array of strings
PARAM_TYPE_ARRAY_INT6Array of integers
PARAM_TYPE_ARRAY_FLOAT7Array of floating-point numbers
PARAM_TYPE_ARRAY_BOOL8Array of boolean values
PARAM_TYPE_ARRAY_OBJECT9Object array
PARAM_TYPE_ARRAY_ARRAY20Nested array
PARAM_TYPE_NULL99Null
PARAM_TYPE_UNSPECIFIED100Unspecified type, for OneOf and AnyOf scenarios

RerankConfig

Rearrange the configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Enabled Boolean No

Whether to enable

ModelName String No

Model name

ResourceConsumption

Single item consumption measurement

Used by actions: DescribeUsageSummaryList.

Name Type Required Description
Label String No

Feature tag. For the PLATFORM scenario, use the PlatformBizType enumeration name; for MODEL/PLUGIN scenarios, leave it empty

Unit Integer No

Consumption measurement unit

Enumeration itemEnumeration valueDescription
DOSAGE_UNIT_TOKEN0token (default)
DOSAGE_UNIT_PAGE_COUNT1page_count (page number)
DOSAGE_UNIT_TIMES2times (count)
DOSAGE_UNIT_SECOND3second (second)
DOSAGE_UNIT_ITEM4item (item)
DOSAGE_UNIT_SHEET5sheet (sheet)
DOSAGE_UNIT_CHARACTER6character (character)
DOSAGE_UNIT_GB7GB
DOSAGE_UNIT_NUMBER8number (count)
DOSAGE_UNIT_MILL_SECOND9mill_second (millisecond)
Value Float No

Consumption value

ResponseParam

ResponseParam

Used by actions: CreatePlugin.

Name Type Required Description
Description String No

Variable description

Name String No

Parameter name

RenderMode Integer No
Enumeration itemEnumeration valueDescription
OUTPUT_RENDER_REPLACE0Overwrite (full replacement)
OUTPUT_RENDER_APPEND1Incremental append
SubParams Array of ResponseParam No

Only useful for OBJECT or ARRAY_OBJECT types

Type Integer No
Enumeration itemEnumeration valueDescription
PARAM_TYPE_STRING0String
PARAM_TYPE_INT1Integer
PARAM_TYPE_FLOAT2Floating-point number
PARAM_TYPE_BOOL3Boolean value
PARAM_TYPE_OBJECT4Object
PARAM_TYPE_ARRAY_STRING5Array of strings
PARAM_TYPE_ARRAY_INT6Array of integers
PARAM_TYPE_ARRAY_FLOAT7Array of floating-point numbers
PARAM_TYPE_ARRAY_BOOL8Array of boolean values
PARAM_TYPE_ARRAY_OBJECT9Object array
PARAM_TYPE_ARRAY_ARRAY20Nested array
PARAM_TYPE_NULL99Null value
PARAM_TYPE_UNSPECIFIED100Unspecified type, used for OneOf and AnyOf scenarios

RetrievalOption

Optional retrieval configuration

Used by actions: SearchKnowledge.

Name Type Required Description
ExpirationAwareness ExpirationAwareness No

Timeliness retrieval enhancement configuration

GraphRag GraphRAG No

GraphRAG Configuration

TableEnhancement TableEnhancement No

Spreadsheet enhancement configuration

RoleConfig

Role configuration

Used by actions: ModifyApp.

Name Type Required Description
RoleDescription String Yes Role description.

SearchAdvancedConfig

Retrieve advanced configuration

Used by actions: SearchKnowledge.

Name Type Required Description
FinalRerankConfig FinalRerankConfig No

Final ReRank Configuration

KbRetrievalList Array of KBRetrievalConfig No

Search configuration of each knowledge base

KnowledgeType Integer No

Retrieve knowledge type: 1=document and QA, 2=rejected question

Enumeration itemEnumeration valueDescription
SEARCH_KNOWLEDGE_TYPE_UNKNOWN0
SEARCH_KNOWLEDGE_TYPE_DOC_QA1Document and QA
SEARCH_KNOWLEDGE_TYPE_REJECTED_QUESTION2Rejected question

RecallCount Integer No

Number of final returned results

SearchBilling

Retrieval billing information

Used by actions: SearchKnowledge.

Name Type Required Description
BillingTagList Array of KVPair No

Billing tag list

FinanceSubBusinessType String No

Billing sub-business type

SearchContext

Retrieval request context info

Used by actions: SearchKnowledge.

Name Type Required Description
CallSource Integer No

Request source

Enumeration itemEnumeration valueDescription
CALL_SOURCE_UNSPECIFIED0
CALL_SOURCE_RAG1Standard mode
CALL_SOURCE_WORKFLOW2Workflow
CALL_SOURCE_PLUGIN3Plug-in
CALL_SOURCE_OPENCLAW4openclaw
CALL_SOURCE_RECALL_TEST5Recall test
CALL_SOURCE_RECALL_TEST_DIFF6Recall test in comparison scenarios also needs to trigger the retrieval interface. The difference is that in this case, the frontend does not need to update the latest configuration. Because when comparing 1, 2, and 3, the final saved one may be 2.

Domain Integer No

adp DOMAIN: 1=development DOMAIN, 2=production DOMAIN

Enumeration itemEnumeration valueDescription
adp_DOMAIN_UNSPECIFIED0not specified
adp_DOMAIN_DEV1development DOMAIN
adp_DOMAIN_PROD2production DOMAIN

VisitorId String No

Visitor ID

SearchFilter

Search filter

Used by actions: SearchKnowledge.

Name Type Required Description
FilterType Integer No

Search filter type

Enumeration itemEnumeration valueDescription
SEARCH_FILTER_TYPE_UNKNOWN0
SEARCH_FILTER_TYPE_CUSTOMER_LABEL_VALUE1User-customized tag value
SEARCH_FILTER_TYPE_CUSTOMER_LABEL_VALUE_ID2User-customized tag value ID
SEARCH_FILTER_TYPE_DOC_ID3Retrieve by specified document ID
SEARCH_FILTER_TYPE_DOC_CATEGORY_ID4Retrieve by specified document classification ID
SEARCH_FILTER_TYPE_DB_TABLE_ID5Retrieve by specified database table ID
SEARCH_FILTER_TYPE_KB_SCHEMA_ID6Specified knowledge base schema ID

FilterValueList Array of String No

Filter value list. According to SearchFilterType, take value 1: pass a custom tag value; 2: pass a custom tag value ID; 3: pass a document ID; 4: pass a category ID

LabelId String No

User-customized tag ID

LogicOp Integer No

Logical operator: AND or OR

Enumeration itemEnumeration valueDescription
LOGIC_OPR_NOOP0
LOGIC_OPR_AND1
LOGIC_OPR_OR2

SearchFilterList Array of SearchFilter No

Nested search filter

SearchFilterConfig

Search filter configuration

Used by actions: SearchKnowledge.

Name Type Required Description
OnlyRetrievalSelectedLabel Boolean No

Whether to retrieve only selected tags. true: retrieve only knowledge with selected tags; false: simultaneous retrieval of knowledge with selected tags and knowledge without any tags

SearchFilter SearchFilter No

Search filter

SearchInput

Retrieval input

Used by actions: SearchKnowledge.

Name Type Required Description
ImageUrlList Array of String No

List of image URLs

Question String No

Query

SubQuestionList Array of String No

Deconstructed sub-problem list

SearchResourceStatusInfo

Search for resource status information

Used by actions: DescribeApp.

Name Type Required Description
ResourceStatus Integer Yes Search resource status: AVAILABLE(1)=resource available, EXHAUSTED(2)=resource used up. Enumeration values: 1: resource available, 2: resource used up

SearchResultPayload

Result payload

Used by actions: SearchKnowledge.

Name Type Required Description
GraphData String No

Additional information of knowledge graph (JSON string)

ImageUrlList Array of String No

List of hit image URLs

SheetInfo String No

Table additional information (JSON string)

SimilarQuestion

QA similar question

Used by actions: DescribeQA.

Name Type Required Description
Content String No

Similar question content

IsAiGenerated Boolean No

Whether AI-generated

SimilarQuestionId String No

Similar question ID

SimilarQuestionExtra

Additional information of the similar question

Used by actions: SearchKnowledge.

Name Type Required Description
Content String No

Text content of the similar question

SimilarQuestionId String No

Similar question ID

SimilarQuestionModifySpec

Modified items of similar questions in a QA

Used by actions: ModifyQA.

Name Type Required Description
Content String No

Content of the similar question (required for CREATE and UPDATE)

ModifyAction Integer No

Operation type: 1=create, 2=modify, 3=delete

Enumeration itemEnumeration valueDescription
MODIFY_ACTION_UNKNOWN0
MODIFY_ACTION_CREATE1Create
MODIFY_ACTION_UPDATE2Modify
MODIFY_ACTION_DELETE3Delete

SimilarQuestionId String No

Similar question ID (required for UPDATE and DELETE)

SimilarQuestionStat

Statistics of similar questions in Q&A

Used by actions: DescribeQA, DescribeQASummaryList.

Name Type Required Description
SimilarQuestionCount Integer No

Number of similar questions

SimilarQuestionTips String No

Similar question prompt (show a similar question example)

SingleWorkflowConfig

Single workflow configuration

Used by actions: ModifyApp.

Name Type Required Description
AsyncWorkflow Boolean Yes

Whether to enable async workflow

Status String Yes

Status Release status (UNPUBLISHED: to be released PUBLISHING: publishing PUBLISHED: released PUBLISHED_FAIL: release failure; DRAFT: to be debugged)

WorkflowDescription String Yes

Workflow description

WorkflowId String Yes

Workflow Id

WorkflowName String Yes

Workflow name.

Enabled Boolean No

Whether the workflow is enabled

SkillAnalysisInfo

SkillAnalysisInfo: Skill security scan information.

Used by actions: DescribeSkillSummaryList.

Name Type Required Description
AnalysisStatus Integer Yes Safety detection status

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | To be checked |
| 1 | detecting |
| 2 | Available |
| 3 | Unavailable |
| 4 | Detection failed |
RiskDescription String Yes Risk description
RiskLevel Integer Yes Risk level

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | risk-free |
| 1 | Low risk |
| 2 | Medium-risk |
| 3 | High-risk |
SecurityReportUrl String Yes Security report redirection url

SkillCategory

SkillCategory classification information.

Used by actions: DescribeSkillCategoryList.

Name Type Required Description
CategoryKey String Yes Category identifier
CategoryName String Yes Category name

SkillClassification

SkillClassification: Skill category and source information.

Used by actions: DescribeSkillSummaryList.

Name Type Required Description
BillingType Integer Yes Billing type of a Skill

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | Free |
| 1 | payment |
BuiltinSource Integer Yes Built-in Skill source. This parameter is valid only when create_type is Skill_create_type_BUILTIN.

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | Placeholder |
| 1 | ADP proprietary |
| 2 | Tencent proprietary |
| 3 | SkillHub |
| 99 | Other |
CategoryKey String Yes Skill category
CreateType Integer Yes Ways to create a Skill

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | Placeholder |
| 1 | file upload |
2 | Generated by an enterprise-level shared process |
| 3 | AIGC generation |
| 99 | Built-in Skill |
ProviderType Integer Yes Skill provider type

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | Placeholder |
| 1 | Official |
| 2 | third party |
| 3 | Custom |
| 4 | Custom enterprise-level sharing |
SourceLink String Yes Skill source link

SkillCorpShareConfig

Skill business shared configuration.

Used by actions: CreateSkillShare, DescribeSkillSummaryList.

Name Type Required Description
ShareScope Integer No
Enumeration item Enumeration value Description
SHARE_SCOPE_TYPE_UNSPECIFIED 0
SHARE_SCOPE_TYPE_ALL 1
SHARE_SCOPE_TYPE_ACCOUNT 2
SHARE_SCOPE_TYPE_SPACE 3

Enumeration values:

  • 0: Unspecified
  • 1: Shared across the business
  • 3: Shared by space
ShareScopeList Array of Identity No

Share range information. Only spaces are supported. StrId is the space ID, and Name is the space name.

SkillNotice

Skill exception notification.

Used by actions: DescribeSkillSummaryList.

Name Type Required Description
Level Integer No Notification level

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | Placeholder |
| 1 | Success, string literal: "success" |
| 2 | Warning, string literal: "warning" |
| 3 | Error, string literal: "error" |
NoticeContent String No Copywriting (post-i18n string)
TriggerVersionId String No Version ID of the Skill that triggers this notice
Type Integer No Notification type

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | Placeholder |
| 1 | Release failure |
| 2 | Shared approval rejected |

SkillProfile

SkillProfile basic display information.

Used by actions: DescribeSkillSummaryList.

Name Type Required Description
CreateTime String Yes

Creation time (Unix seconds).

Creator String Yes

Creator.

Description String Yes

Skill description

DisplayDescription String Yes

Skill show description

DisplayName String Yes

Skill display name

IconUrl String Yes

Skill icon

Name String Yes

Skill name

UpdateTime String Yes

Update time (Unix seconds).

SpaceId String No

Space

SkillReferenceGroup

Reference groups under the same SkillRefType (including total count + list of reference details). total_count is always based on the unfiltered original total amount. reference_summary_list is affected by the secondary authorization switch.

Used by actions: DescribeSkillReferenceList.

Name Type Required Description
ReferenceSummaryList Array of SkillReferenceSummary No

Reference detail list under this type

ReferenceType Integer No
Enumeration item Enumeration value Description
SKILL_REF_UNKNOWN 0 Placeholder
SKILL_REF_OPENCLAW 1 openclaw
SKILL_REF_AGENT 2 agent
SKILL_REF_CORP_ASSISTANT 3 Business assistant
TotalCount Integer No

Total number of references of this type

SkillReferenceSummary

Reference abstract (for detail page display, corresponding to DB t_skill_reference)

Used by actions: DescribeSkillReferenceList.

Name Type Required Description
ReferenceId String No

Associated ID

ReferenceName String No

Association name

ReferenceType Integer No

Association type

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | Placeholder |
| 1 | ClawPro |
| 2 | agent |

SpaceId String No

Space ID

SpaceName String No

Space name

Owner String No

Reference instance owner

AppIdentity AppIdentity No

Application identifier

SkillShare

SkillShare Skill business share information.

Used by actions: DescribeSkillSummaryList.

Name Type Required Description
ApprovalId String Yes

Approval ID

ShareSkillId String Yes

New skill_id associated after sharing

ShareVersion String Yes

Shared version, for example 1.0.0

ShareVersionId String Yes

Shared version ID

SkillId String Yes

Original skill_id

Status Integer Yes

Shared state

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | Not shared |
| 1 | Shared |
| 2 | Pending Approval |

CorpShareConfig SkillCorpShareConfig No

Business share scope

SkillSummary

Skill summary in the SkillSummary list.

Used by actions: DescribeSkillSummaryList.

Name Type Required Description
ClassificationInfo SkillClassification Yes Classification information
CurrentVersionInfo SkillVersion Yes Current version information
IsFavorite Boolean Yes Whether the current user collects it
Profile SkillProfile Yes Basic information
SkillId String Yes Skill ID
NoticeList Array of SkillNotice No Skill exception notification list
PermissionIdList Array of String No List of resource operation permission bits of the current user for this Skill. This parameter is fixed as an empty array for built-in or shared skills.
ShareList Array of SkillShare No Share information; there may be two entries, one is shared and the other is under review.
SkillStatus Integer No Skill status

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | Initialization (no published versions, and the latest version is in INITIALIZED/UNRELEASED) |
Security detection in progress (no published versions, and the latest version is in AUDITING)
| 2 | To be released (no published versions, and the latest version is in PENDING_RELEASE) |
| 3 | Released (any RELEASED version exists, absorbent state) |

SkillVersion

SkillVersion version information.

Used by actions: DescribeSkillSummaryList.

Name Type Required Description
AnalysisInfo SkillAnalysisInfo Yes

Detection information

Version String Yes

Current effective version number.

VersionId String Yes

Current effective version ID

VersionStatus Integer No

Skill version RELEASE process status:

  - 0 INITIALIZED      initialization (initial version state)  - 1 AUDITING         under review (f_analysis_status ∈ {PENDING, RUNNING})  - 2 PENDING_RELEASE  awaiting RELEASE (low/medium-risk, waiting for user confirmation to publish)  - 3 RELEASED         RELEASED  - 4 UNRELEASED       not RELEASED (HIGH / UNAVAILABLE / FAILED / user give up, including the semantics of historical "not approved")Decoupled from SkillAnalysisStatus: the former is the RELEASE lifecycle from the user perspective, while the latter is the security detection stage.
SkillMd5 String No

md5 information of the Skill package

SkillUrl String No

Version package address

CreateTime String No

Version creation time (Unix seconds).

SkillMarkdownUrl String No

skill md document

UpdateDesc String No

Version change description

Updater String No

Change user.

Space

Spatial information

Used by actions: DescribeSpaceList.

Name Type Required Description
SpaceId String No

Space id

Name String No

Space name

Description String No

Space description.

PermissionIdList Array of String No

Space permissions

CreateTime String No

Creation time.

Parameter format: timestamp in seconds

UpdateTime String No

Update time

Parameter format: timestamp

SpecialStatusInfo

Special status information.

Used by actions: DescribeApp.

Name Type Required Description
Status Integer Yes Status (0: not in a special status, 1: in a special status). Enumeration value: 1: in a special status

Statistic

Statistics

Used by actions: DescribeNodeRunDetail.

Name Type Required Description
FirstTokenCostMs Integer Yes

Time to first token

InputTokens Integer Yes

Input token count

ModelName String Yes

Model name

OutputTokens Integer Yes

Output token count

TotalCostMs Integer Yes

Total reasoning time

TotalTokens Integer Yes

Total input and output tokens

SummaryListSwitch

Abstract list query common switch configuration

Used by actions: DescribeCategoryList, DescribeLabelSummaryList, DescribeQASummaryList.

Name Type Required Description
ShowMetadataEnabled Boolean No

Whether to display metadata

SupportedFileType

Supported file types

Used by actions: ModifyApp.

Name Type Required Description
Description String Yes

Description.

FileExt String Yes

File type (for example, txt, pdf, jpg; extension is recommended)

MaxSizeBytes String Yes

File size limit (unit: byte)

SystemVariable

System variable

Used by actions: DescribeSystemVariableList.

Name Type Required Description
Description String Yes Variable Description
Name String Yes Variable name

TableEnhancement

Table enhancement configuration

Used by actions: SearchKnowledge.

Name Type Required Description
Enabled Boolean No

Whether to enable

ThinkModel

Thinking model configuration

Used by actions: ModifyApp.

Name Type Required Description
Model ModelDetailInfo Yes Thinking model

TimeRange

Query time range (Unix seconds)

Used by actions: DescribeAppStatisticsOverview, DescribeConcurrencyLimitDetailList, DescribeUsageSummaryList.

Name Type Required Description
EndTime String Yes

End time in Unix seconds

StartTime String Yes

Start time in Unix seconds

TimerPushConfig

TimerPushConfig

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
PushChannel Integer No

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | |
| 1 | Do not push |
| 2 | WeChat official account |
| 3 | WeCom AI chatbot |

PushTargetId String No

Push session ID

PushTargetType Integer No

Enumeration values:
| uint | Description |
| --- | --- |
| 0 | |
| 1 | User (WeChat official account openid) |
| 2 | Group chat (WeCom chatbot chat_id) |

PushWebhookUrl String No

url for pushing webhook

TimerScheduleConfig

TimerScheduleConfig

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
Cron CronSchedule No Cron configuration.
Daily DailySchedule No Daily trigger
Interval IntervalSchedule No Fixed interval
ManualOnly ManualOnlySchedule No Manual only
Once OnceSchedule No Single time
ScheduleType Integer No Enumeration values:
| uint | Description |
| --- | --- |
| 0 | |
Manual only
| 2 | Daily |
| 3 | Weekly |
| 4 | By interval |
| 5 | One-time |
| 6 | Cron |
Timezone String No Time zone
Weekly WeeklySchedule No Triggers at a fixed time weekly.

TokenUsage

Token usage statistics

Used by actions: SearchKnowledge.

Name Type Required Description
CompletionTokens Integer No

Number of completion tokens

ModelName String No

Model name

PromptTokens Integer No

prompt token count

TotalTokens Integer No

Total token count

Tool

Tool

Used by actions: CreatePlugin, DescribePlugin.

Name Type Required Description
Billing ToolBilling No

Tool billing information

CallCount Integer No

Tool call count

Unit: count

Description String No

Tool description

Name String No

Tool name

PluginId String No

Plug-in ID

ToolAccessMode Integer No
Enumeration itemEnumeration valueDescription
TOOL_ACCESS_MODE_UNKNOWN0Not specified
TOOL_ACCESS_MODE_READ_ONLY1Read-only
TOOL_ACCESS_MODE_WRITE_DELETE2Write/Delete
ToolConfig ToolConfig No

Tool configuration info

ToolId String No

Tool ID

ToolBilling

ToolBilling

Used by actions: CreatePlugin.

Name Type Required Description
BasicBilling BasicBilling No

Basic Billing Information

BillingType Integer No
Enumeration item Enumeration value Description
BILLING_TYPE_FREE 0 Free
BILLING_TYPE_LIMITED_FREE 1 Limited-time free
BILLING_TYPE_OFFICIAL_PAID 2 Official charges
BILLING_TYPE_OFFICIAL_PAID_OLD_FREE 3 Official charges (fees for new/upgraded users, limited-time free for existing users)
ComplexBilling ComplexBilling No

Composite type billing information

DuplexBilling DuplexBilling No

Bidirectional billing information

ToolConfig

ToolConfig

Used by actions: CreatePlugin.

Name Type Required Description
ApiToolConfig ApiToolConfig No

API tool configuration message.

AppToolConfig AppToolConfig No

Application configuration information

CodeToolConfig CodeToolConfig No

Code tool configuration message

MCPToolConfig MCPToolConfig No

Configuration information of the MCP tool

ToolExample

ToolExample

Used by actions: CreatePlugin.

Name Type Required Description
Request String No

Request parameters

Response String No

Response parameter.

ToolSummary

Tool information

Used by actions: DescribePluginSummaryList.

Name Type Required Description
ToolId String No

Tool Id

TriggerConfig

TriggerConfig

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
ScheduledConfig AppTriggerScheduleConfig No

Timer configuration.

WebhookConfig AppTriggerWebhookConfig No

Webhook configuration

TriggerStatus

TriggerStatus

Used by actions: DescribeAppTrigger, DescribeAppTriggerSummaryList, ModifyAppTrigger.

Name Type Required Description
ScheduledStatus AppTriggerScheduleStatus No

Timer status.

Scope Integer No
Enumeration item Enumeration value Description
APP_TRIGGER_SCOPE_UNSPECIFIED 0 Unspecified
APP_TRIGGER_SCOPE_APP 1 B-end admin
APP_TRIGGER_SCOPE_USER 2 C-end visitor
UserId String No

Visitor id

WebhookStatus AppTriggerWebhookStatus No

Webhook status

UsageSummary

Aggregated details of resource usage

Used by actions: DescribeUsageSummaryList.

Name Type Required Description
Model ModelUsageSummary No

Exclusive to MODEL domain

Platform PlatformUsageSummary No

PLATFORM domain exclusive

Plugin PluginUsageSummary No

Exclusive to PLUGIN domain

SourceId String No

Source ID; CORP view=space_id (corporate view grouped by space), SPACE view=app_id (uint64 string), APP view=app_id

SourceName String No

Source name; CORP view=space_name, SPACE view=app_name, APP view=app_name

ViewType Integer No

View type, determines the business meaning of SourceId/SourceName

Enumeration itemEnumeration valueDescription
VIEW_TYPE_UNSPECIFIED0Unspecified (invalid value, do not pass in requests)
VIEW_TYPE_CORP1Corporate view
VIEW_TYPE_SPACE2Space view
VIEW_TYPE_APP3Application view

Variable

Variable information

Used by actions: CreateVariable, DescribeVariable, DescribeVariableList, ModifyVariable.

Name Type Required Description
DefaultFileName String Yes

Default file name.

DefaultValue String Yes

Default value.

Description String Yes

Variable description

ModuleType Integer Yes

Variable module type

Enumeration values:

  • 0: API parameter
  • 1: environment parameter
  • 2: application parameter
  • 3: system parameter
Name String Yes

Variable name

Type Integer Yes

Variable type

Enumeration values:

  • 0: string
  • 1: integer
  • 2: floating-point number
  • 3: boolean value
  • 4: object
  • 5: array of strings
  • 6: array of integers
  • 7: array of floating-point numbers
  • 8: array of boolean values
  • 9: object array
  • 10: file
  • 11: document
  • 12: image
  • 13: audio
  • 14: video
  • 15: file array
  • 16: document array
  • 17: image array
  • 18: audio array
  • 19: video array
  • 20: array of arrays
  • 21: key
VariableId String Yes

Variable ID

EnableEndpoints Boolean No

Whether to enable network policy (only effective for environment variables)

EndpointList Array of String No

Network policy list (Supported: precise domain name, *.wildcard domain, with optional protocol/port/path prefix)

IsBuiltin Boolean No

Whether it is a built-in variable.

EnableSandbox Boolean No

Whether it can be injected into the sandbox environment.

ViewScope

View scope

Used by actions: DescribeAppStatisticsOverview, DescribeConcurrencyLimitDetailList, DescribeUsageSummaryList.

Name Type Required Description
ViewType Integer Yes

View type; enumeration values: VIEW_TYPE_CORP(1) corporate view, VIEW_TYPE_SPACE(2) space view, VIEW_TYPE_APP(3) application view

Enumeration itemEnumeration valueDescription
VIEW_TYPE_UNSPECIFIED0Not specified (invalid value, do not pass in requests)
VIEW_TYPE_CORP1Corporate view
VIEW_TYPE_SPACE2Space view
VIEW_TYPE_APP3Application view
ScopeId String No

View scope ID; leave empty for VIEW_TYPE_CORP; enter space_id for VIEW_TYPE_SPACE; enter app_id for VIEW_TYPE_APP (decimal string of uint64 snowflake ID)

VoiceConfig

VoiceConfig

Used by actions: ModifyApp.

Name Type Required Description
TimbreKey String Yes Digital human tone key, which needs to align with the public cloud voice type id.
VoiceName String Yes Timbre name
VoiceType Integer Yes Public cloud timbre id

WeeklySchedule

WeeklySchedule

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
Times Array of WeeklyTime No Scheduled configuration (week)

WeeklyTime

WeeklyTime

Used by actions: CreateAppTrigger, DescribeAppTrigger, ModifyAppTrigger.

Name Type Required Description
TimeOfDay String No Time
Weekday Integer No Day of the week

WorkflowRun

Workflow running instance information

Used by actions: DescribeWorkflowRun.

Name Type Required Description
WorkflowRunSummary WorkflowRunSummary No Basic information of the workflow running instance
WorkflowRunOutput WorkflowRunOutput No Workflow run instance output information
WorkflowRunMetadata WorkflowRunMetadata No Workflow run instance metadata

WorkflowRunMetadata

Workflow running instance metadata

Used by actions: DescribeWorkflowRun.

Name Type Required Description
Query String No User input.
MainModelName String No Name of the main model
CustomVariableList Array of CustomVariable No API parameter configuration
WorkflowGraph String No Flowchart of the workflow

WorkflowRunOutput

Workflow run instance output information

Used by actions: DescribeWorkflowRun.

Name Type Required Description
Output String No Workflow output
LatestMessage ReplyMessage No Current reply message

WorkflowRunProfile

Basic information of the workflow running instance

Used by actions: DescribeWorkflowRun.

Name Type Required Description
AppId String No Application ID
WorkflowRunId String No ID of the workflow running instance
WorkflowId String No Workflow ID
Name String No Name

WorkflowRunResult

Workflow running instance status information

Used by actions: DescribeWorkflowRun.

Name Type Required Description
Status Integer No Running state. 1: Queuing; 2: running; 3: run successfully; 4: fail to run; 5: canceled
FailMessage String No Error message
TotalTokens Integer No Total number of tokens consumed

WorkflowRunSummary

Basic information of the workflow running instance

Used by actions: DescribeWorkflowRun.

Name Type Required Description
Domain Integer No

Runtime environment. 1: Development domain, 2: Production domain

WorkflowRunProfile WorkflowRunProfile No

Basic information of workflow operation instance

WorkflowRunResult WorkflowRunResult No

Workflow operation instance result

WorkflowRunTime WorkflowRunTime No

Time information of workflow running instance

WorkflowRunTime

Workflow running instance time information

Used by actions: DescribeWorkflowRun.

Name Type Required Description
CreateTime String No Creation time (a millisecond timestamp).
StartTime String No Start time (timestamp in milliseconds)
EndTime String No End time (timestamp in milliseconds)

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan