# Tencent Cloud DataBuddy API

> Tencent Cloud DataBuddy API on Apizie: 95 endpoints (Add Console Users, Add Workspace Groups, Add Workspace Users, Create Catalog, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:tencent-databuddy/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:tencent-databuddy`
- Category: Cloud
- Status: byok
- Source: https://www.tencentcloud.com/document/api
- Page: https://apizie.tech/api/cloud/tencent-databuddy
- OpenAPI: https://apizie.tech/api/cloud/tencent-databuddy/openapi.json

Tencent Cloud API 3.0 for DataBuddy (databuddy). Every call is signed with TC3-HMAC-SHA256 using your SecretId and SecretKey.

## Endpoints

### Add Console Users
`POST https://apizie.tech/v1/cloud:tencent-databuddy/add-console-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| UserUins | array | yes |  |
| RoleIds | array | yes |  |

### Add Workspace Groups
`POST https://apizie.tech/v1/cloud:tencent-databuddy/add-workspace-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| GroupIds | array | yes |  |
| WorkspaceId | string | yes |  |
| RoleIds | array | yes |  |

### Add Workspace Users
`POST https://apizie.tech/v1/cloud:tencent-databuddy/add-workspace-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| UserUins | array | yes |  |
| WorkspaceId | string | yes |  |
| RoleIds | array | yes |  |

### Create Catalog
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Name | string | yes |  |
| Type | string | yes |  |
| WorkspaceId | string | yes |  |
| Comment | string | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |
| ConnectionCatalogName | string | no |  |

### Create Console Group
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-console-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| GroupName | string | yes |  |
| GroupNickname | string | no |  |
| Description | string | no |  |

### Create File
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| FileName | string | yes |  |
| ParentFolderPath | string | no |  |
| FileType | string | no |  |
| FileConfig | object | no |  |
| BundleId | string | no |  |
| BundleInfo | string | no |  |
| Storage | object | no |  |
| ExtractArchive | boolean | no |  |

### Create Folder
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| FolderName | string | yes |  |
| FolderType | string | yes |  |
| ParentFolder | object | no |  |
| GitConfig | object | no |  |

### Create Location
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |

### Create Model
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| ModelName | string | yes |  |
| WorkspaceId | string | yes |  |
| Comment | string | no |  |
| Properties | array | no |  |

### Create Model Version
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-model-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| ModelName | string | yes |  |
| Uri | string | yes |  |
| WorkspaceId | string | yes |  |
| Aliases | array | no |  |
| Comment | string | no |  |
| Properties | array | no |  |

### Create Schema
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| Name | string | yes |  |
| WorkspaceId | string | yes |  |
| Comment | string | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Create Volume
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-volume` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| VolumeName | string | yes |  |
| WorkspaceId | string | yes |  |
| Comment | string | no |  |
| Properties | array | no |  |
| StorageLocation | string | no |  |
| Type | string | no |  |

### Create Workflow
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| BaseInfo | object | yes |  |
| Trigger | array | no |  |
| ParamList | array | no |  |
| LabelList | array | no |  |
| Alarm | object | no |  |
| MonitorMetric | object | no |  |
| AdvanceConfig | object | no |  |
| TaskList | array | no |  |
| BundleId | string | no |  |
| BundleInfo | string | no |  |
| GitConfigId | string | no |  |
| GitBranch | string | no |  |

### Create Workspace
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceName | string | yes |  |
| WorkspaceRegion | string | yes |  |
| Description | string | no |  |

### Create Workspace Role
`POST https://apizie.tech/v1/cloud:tencent-databuddy/create-workspace-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| BasicInfo | object | yes |  |
| Permissions | array | no |  |

### Delete Catalog
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| WorkspaceId | string | yes |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Delete Console Groups
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-console-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| GroupIds | array | yes |  |

### Delete File
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| FileId | string | yes |  |
| FileType | string | no |  |

### Delete Folder
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| Folder | object | yes |  |
| ForceDelete | boolean | no |  |

### Delete Location
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| LocationName | string | yes |  |
| WorkspaceId | string | yes |  |

### Delete Model
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| ModelName | string | yes |  |
| WorkspaceId | string | yes |  |

### Delete Schema
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| WorkspaceId | string | yes |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Delete Table
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| TableName | string | yes |  |
| WorkspaceId | string | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Delete View
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| ViewName | string | yes |  |
| WorkspaceId | string | yes |  |

### Delete Volume
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-volume` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| VolumeName | string | yes |  |
| WorkspaceId | string | yes |  |

### Delete Workflow
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| WorkflowId | string | yes |  |

### Delete Workspace
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |

### Delete Workspace Role
`POST https://apizie.tech/v1/cloud:tencent-databuddy/delete-workspace-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| RoleId | string | yes |  |

### Get Catalog
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| WorkspaceId | string | yes |  |
| CatalogId | string | no |  |
| FetchOption | object | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Get File
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| FileId | string | no |  |
| FileType | string | no |  |
| IncludeContent | boolean | no |  |
| VersionId | string | no |  |
| FilePath | string | no |  |

### Get Folder
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| Folder | object | yes |  |

### Get Location
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| LocationName | string | yes |  |
| WorkspaceId | string | yes |  |

### Get Model
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| ModelName | string | yes |  |
| WorkspaceId | string | yes |  |
| FetchOption | object | no |  |

### Get Model Version
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-model-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| ModelName | string | yes |  |
| ModelVersion | integer | yes |  |
| WorkspaceId | string | yes |  |

### Get Schema
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| WorkspaceId | string | yes |  |
| FetchOption | object | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Get Table
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| TableName | string | yes |  |
| WorkspaceId | string | yes |  |
| FetchOption | object | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Get Tables
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| FullNames | array | yes |  |
| FetchOption | object | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Get View
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| ViewName | string | yes |  |
| WorkspaceId | string | no |  |
| FetchOption | object | no |  |

### Get Volume
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-volume` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| VolumeName | string | yes |  |
| WorkspaceId | string | yes |  |
| FetchOption | object | no |  |

### Get Workflow
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| WorkflowId | string | yes |  |

### Get Workflow Run
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-workflow-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| WorkflowRunId | string | yes |  |

### Get Workflow Task Run
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-workflow-task-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| WorkflowTaskRunId | string | yes |  |
| InnerWorkflowTaskRunListOption | object | no |  |

### Get Workspace
`POST https://apizie.tech/v1/cloud:tencent-databuddy/get-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |

### Kill Workflow Run
`POST https://apizie.tech/v1/cloud:tencent-databuddy/kill-workflow-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| WorkflowId | string | yes |  |
| WorkflowRunIds | array | no |  |
| KillAllRuns | boolean | no |  |
| OnlyKillPendingRuns | boolean | no |  |

### List Catalog Names
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-catalog-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| MaxResults | string | no |  |
| PageToken | string | no |  |
| Types | array | no |  |
| CatalogSources | array | no |  |

### List Catalogs
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-catalogs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| MaxResults | integer | no |  |
| PageToken | string | no |  |
| Types | array | no |  |
| CurrentWorkspaceOnly | boolean | no |  |
| FetchOption | object | no |  |
| CatalogSources | array | no |  |

### List Console Group Users
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-console-group-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| GroupId | string | yes |  |
| UserKeyword | string | no |  |
| UserUins | array | no |  |
| OrderBys | array | no |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |

### List Console Groups
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-console-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| GroupIds | array | no |  |
| GroupKeyword | string | no |  |
| OrderBys | array | no |  |

### List Console Roles
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-console-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| RoleKeyword | string | no |  |

### List Console Users
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-console-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| UserKeyword | string | no |  |
| RoleIds | array | no |  |
| OrderBys | array | no |  |

### List Feature Tables
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-feature-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| Keyword | string | no |  |
| CatalogNames | array | no |  |
| Tags | array | no |  |
| OwnerMe | boolean | no |  |
| MaxResults | integer | no |  |
| PageToken | string | no |  |
| OrderBys | array | no |  |

### List Files
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| Parent | object | no |  |
| FileTypes | array | no |  |
| NameKeyword | string | no |  |
| OwnerUserUins | array | no |  |
| OnlyFolder | boolean | no |  |
| OrderBys | array | no |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |

### List Locations
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-locations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| LocationNamePattern | string | no |  |
| SnapshotBased | boolean | no |  |
| SnapshotId | string | no |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |

### List Models
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-models` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| MaxResults | integer | yes |  |
| WorkspaceId | string | yes |  |
| PageToken | string | no |  |
| FetchOption | object | no |  |

### List Schema Names
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-schema-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| WorkspaceId | string | yes |  |
| MaxResults | string | no |  |
| PageToken | string | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### List Schemas
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-schemas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| WorkspaceId | string | yes |  |
| MaxResults | integer | no |  |
| PageToken | string | no |  |
| FetchOption | object | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### List Table Names
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-table-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| WorkspaceId | string | yes |  |
| MaxResults | string | no |  |
| PageToken | string | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### List Tables
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| WorkspaceId | string | yes |  |
| MaxResults | integer | no |  |
| PageToken | string | no |  |
| FetchOption | object | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### List View Names
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-view-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| WorkspaceId | string | yes |  |
| MaxResults | string | no |  |
| PageToken | string | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### List Views
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-views` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| WorkspaceId | string | yes |  |
| MaxResults | integer | no |  |
| PageToken | string | no |  |
| FetchOption | object | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### List Volumes
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-volumes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| MaxResults | integer | yes |  |
| WorkspaceId | string | yes |  |
| PageToken | string | no |  |
| FetchOption | object | no |  |

### List Workflow Runs
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-workflow-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| WorkflowId | string | no |  |
| WorkflowNameKeyword | string | no |  |
| CreateStartTime | string | no |  |
| CreateEndTime | string | no |  |
| RunStates | array | no |  |
| ErrorCodeStrings | array | no |  |
| RunUserUins | array | no |  |
| LabelKeyIds | array | no |  |
| LabelValueIds | array | no |  |
| OrderBys | array | no |  |

### List Workflow Task Runs
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-workflow-task-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| TaskId | string | no |  |
| WorkflowRunId | string | no |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |

### List Workflows
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| WorkflowNameKeyword | string | no |  |
| WorkflowNames | array | no |  |
| WorkflowIds | array | no |  |
| RunUserUins | array | no |  |
| LabelKeyIds | array | no |  |
| LabelValueIds | array | no |  |
| QuickSelectionType | string | no |  |
| OrderBys | array | no |  |

### List Workspace Group Users
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-workspace-group-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| GroupId | string | yes |  |
| NameKeywords | string | no |  |
| UserUins | array | no |  |
| OrderBys | array | no |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |

### List Workspace Groups
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-workspace-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| GroupIds | array | no |  |
| GroupKeyword | string | no |  |
| RoleIds | array | no |  |
| OrderBys | array | no |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| GroupType | string | no |  |

### List Workspace Users
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-workspace-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| UserKeyword | string | no |  |
| RoleIds | array | no |  |
| UserUins | array | no |  |
| OrderBys | array | no |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| ExtendInfo | string | no |  |

### List Workspaces
`POST https://apizie.tech/v1/cloud:tencent-databuddy/list-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | no |  |
| WorkspaceKeyword | string | no |  |
| StatusList | array | no |  |
| OrderBys | array | no |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| WorkspaceRegion | array | no |  |
| Creator | array | no |  |

### Remove Console Users
`POST https://apizie.tech/v1/cloud:tencent-databuddy/remove-console-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| UserUins | array | yes |  |

### Remove Workspace Groups
`POST https://apizie.tech/v1/cloud:tencent-databuddy/remove-workspace-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| GroupIds | array | yes |  |
| WorkspaceId | string | yes |  |

### Rerun Workflow Run
`POST https://apizie.tech/v1/cloud:tencent-databuddy/rerun-workflow-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| WorkflowId | string | yes |  |
| WorkflowRunId | string | yes |  |
| RunType | integer | yes |  |
| AdvancedParams | array | no |  |
| TaskIds | array | no |  |
| ScheduledTimeConfig | object | no |  |

### Run Workflow
`POST https://apizie.tech/v1/cloud:tencent-databuddy/run-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| WorkflowId | string | yes |  |
| RunType | integer | yes |  |
| AdvancedParams | array | no |  |
| TaskIds | array | no |  |
| IdempotencyToken | string | no |  |
| ScheduledTimeConfig | object | no |  |

### Search Asset
`POST https://apizie.tech/v1/cloud:tencent-databuddy/search-asset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| MaxResults | integer | no |  |
| Keyword | string | no |  |
| AssetTypes | array | no |  |
| PageToken | string | no |  |
| Owner | array | no |  |
| TagIds | array | no |  |
| TagValueIds | array | no |  |
| ModifiedTime | string | no |  |
| CatalogNames | array | no |  |
| WorkspacePaths | array | no |  |
| EnableHybridSearch | boolean | no |  |
| FieldTagIds | array | no |  |
| OrderBys | array | no |  |

### Start Compute
`POST https://apizie.tech/v1/cloud:tencent-databuddy/start-compute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| ComputeResourceId | string | no |  |
| ResourceId | string | no |  |

### Stop Compute
`POST https://apizie.tech/v1/cloud:tencent-databuddy/stop-compute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| ComputeResourceId | string | no |  |
| ResourceId | string | no |  |

### Unbind Workflow Bundle
`POST https://apizie.tech/v1/cloud:tencent-databuddy/unbind-workflow-bundle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| WorkflowId | string | yes |  |

### Update Catalog
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| WorkspaceId | string | yes |  |
| NewComment | string | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Update Console Group
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-console-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| GroupId | string | yes |  |
| OperType | integer | yes |  |
| GroupName | string | no |  |
| GroupNickname | string | no |  |
| Description | string | no |  |
| UserUins | array | no |  |

### Update Console Users
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-console-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| UserUins | array | yes |  |
| RoleIds | array | yes |  |

### Update File
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| FileId | string | yes |  |
| FileConfig | object | no |  |
| FileType | string | no |  |
| BundleId | string | no |  |
| BundleInfo | string | no |  |
| Storage | object | no |  |
| FileName | string | no |  |
| ParentFolderPath | string | no |  |
| TargetFileType | string | no |  |
| UpdateAction | integer | no |  |

### Update Folder
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| Folder | object | no |  |
| OperationType | string | no |  |
| FolderName | string | no |  |
| TargetParent | object | no |  |

### Update Function
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| FunctionName | string | yes |  |
| WorkspaceId | string | yes |  |
| NewComment | string | no |  |

### Update Location
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| LocationName | string | yes |  |
| Updates | array | yes |  |
| WorkspaceId | string | yes |  |

### Update Model
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| ModelName | string | yes |  |
| WorkspaceId | string | yes |  |
| NewName | string | no |  |
| NewComment | string | no |  |

### Update Model Version
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-model-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| ModelName | string | yes |  |
| ModelVersion | integer | yes |  |
| WorkspaceId | string | yes |  |
| AddedAliases | array | no |  |
| RemovedAliases | array | no |  |
| NewComment | string | no |  |

### Update Schema
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| WorkspaceId | string | yes |  |
| NewComment | string | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Update Table
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| TableName | string | yes |  |
| WorkspaceId | string | yes |  |
| NewName | string | no |  |
| NewComment | string | no |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Update Table Column
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-table-column` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| TableName | string | yes |  |
| WorkspaceId | string | yes |  |
| Columns | array | yes |  |
| ConnectionId | string | no |  |
| CatalogSource | string | no |  |

### Update View
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| ViewName | string | yes |  |
| WorkspaceId | string | yes |  |
| NewName | string | no |  |
| NewComment | string | no |  |

### Update Volume
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-volume` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CatalogName | string | yes |  |
| SchemaName | string | yes |  |
| VolumeName | string | yes |  |
| WorkspaceId | string | yes |  |
| NewName | string | no |  |
| NewComment | string | no |  |

### Update Workflow
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| WorkflowId | string | yes |  |
| FieldToRemoveList | array | no |  |
| NewSetting | object | no |  |

### Update Workspace
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| WorkspaceName | string | yes |  |
| Description | string | no |  |

### Update Workspace Groups Roles
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-workspace-groups-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| GroupIds | array | yes |  |
| WorkspaceId | string | yes |  |
| RoleIds | array | yes |  |

### Update Workspace Role
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-workspace-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| WorkspaceId | string | yes |  |
| BasicInfo | object | yes |  |
| Permissions | array | no |  |

### Update Workspace Users Roles
`POST https://apizie.tech/v1/cloud:tencent-databuddy/update-workspace-users-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| UserUins | array | yes |  |
| WorkspaceId | string | yes |  |
| RoleIds | array | yes |  |

## Example
```
curl "https://apizie.tech/v1/cloud:tencent-databuddy/add-console-users" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Tencent Cloud DataBuddy API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:tencent-databuddy/add-console-users with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Tencent Cloud DataBuddy API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Tencent Cloud DataBuddy itself also needs your own key from tencentcloudapi.com.

### Can AI agents use the Tencent Cloud DataBuddy API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:tencent-databuddy.

### What is the status of the Tencent Cloud DataBuddy API?
Needs your own provider key (bring your own key)