# Tencent Cloud Interactive Whiteboard API

> Tencent Cloud Interactive Whiteboard API on Apizie: 35 endpoints (Create PPTCheck Task, Create Snapshot Task, Create Transcode, Create Video Generation Task, …) 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-tiw/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

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

## Endpoints

### Create PPTCheck Task
`POST https://apizie.tech/v1/cloud:tencent-tiw/create-pptcheck-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| SdkAppId | integer | yes |  |
| Url | string | yes |  |
| AutoHandleUnsupportedElement | boolean | no |  |
| AutoHandleUnsupportedElementTypes | array | no |  |

### Create Snapshot Task
`POST https://apizie.tech/v1/cloud:tencent-tiw/create-snapshot-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Whiteboard | object | yes |  |
| SdkAppId | integer | yes |  |
| RoomId | integer | yes |  |
| CallbackURL | string | no |  |
| COS | object | no |  |
| SnapshotMode | string | no |  |

### Create Transcode
`POST https://apizie.tech/v1/cloud:tencent-tiw/create-transcode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| SdkAppId | integer | yes |  |
| Url | string | yes |  |
| IsStaticPPT | boolean | no |  |
| MinResolution | string | no |  |
| ThumbnailResolution | string | no |  |
| CompressFileType | string | no |  |
| ExtraData | string | no |  |
| Priority | string | no |  |
| MinScaleResolution | string | no |  |
| AutoHandleUnsupportedElement | boolean | no |  |
| AutoHandleUnsupportedElementTypes | array | no |  |
| ExcelParam | object | no |  |

### Create Video Generation Task
`POST https://apizie.tech/v1/cloud:tencent-tiw/create-video-generation-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| OnlineRecordTaskId | string | yes |  |
| SdkAppId | integer | yes |  |
| Whiteboard | object | no |  |
| Concat | object | no |  |
| MixStream | object | no |  |
| RecordControl | object | no |  |
| ExtraData | string | no |  |

### Describe Online Record
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-online-record` (byok)

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

### Describe Online Record Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-online-record-callback` (byok)

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

### Describe PPTCheck
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-pptcheck` (byok)

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

### Describe PPTCheck Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-pptcheck-callback` (byok)

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

### Describe Running Tasks
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-running-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| SdkAppID | integer | yes |  |
| TaskType | string | yes |  |
| Offset | integer | no |  |
| Limit | integer | no |  |

### Describe Snapshot Task
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-snapshot-task` (byok)

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

### Describe Transcode
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-transcode` (byok)

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

### Describe Transcode By Url
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-transcode-by-url` (byok)

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

### Describe Transcode Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-transcode-callback` (byok)

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

### Describe Video Generation Task
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-video-generation-task` (byok)

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

### Describe Video Generation Task Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-video-generation-task-callback` (byok)

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

### Describe Warning Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-warning-callback` (byok)

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

### Describe Whiteboard Push
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-whiteboard-push` (byok)

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

### Describe Whiteboard Push Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/describe-whiteboard-push-callback` (byok)

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

### Pause Online Record
`POST https://apizie.tech/v1/cloud:tencent-tiw/pause-online-record` (byok)

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

### Resume Online Record
`POST https://apizie.tech/v1/cloud:tencent-tiw/resume-online-record` (byok)

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

### Set Online Record Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/set-online-record-callback` (byok)

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

### Set Online Record Callback Key
`POST https://apizie.tech/v1/cloud:tencent-tiw/set-online-record-callback-key` (byok)

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

### Set PPTCheck Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/set-pptcheck-callback` (byok)

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

### Set PPTCheck Callback Key
`POST https://apizie.tech/v1/cloud:tencent-tiw/set-pptcheck-callback-key` (byok)

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

### Set Transcode Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/set-transcode-callback` (byok)

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

### Set Transcode Callback Key
`POST https://apizie.tech/v1/cloud:tencent-tiw/set-transcode-callback-key` (byok)

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

### Set Video Generation Task Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/set-video-generation-task-callback` (byok)

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

### Set Video Generation Task Callback Key
`POST https://apizie.tech/v1/cloud:tencent-tiw/set-video-generation-task-callback-key` (byok)

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

### Set Warning Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/set-warning-callback` (byok)

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

### Set Whiteboard Push Callback
`POST https://apizie.tech/v1/cloud:tencent-tiw/set-whiteboard-push-callback` (byok)

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

### Set Whiteboard Push Callback Key
`POST https://apizie.tech/v1/cloud:tencent-tiw/set-whiteboard-push-callback-key` (byok)

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

### Start Online Record
`POST https://apizie.tech/v1/cloud:tencent-tiw/start-online-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| SdkAppId | integer | yes |  |
| RoomId | integer | yes |  |
| RecordUserId | string | yes |  |
| RecordUserSig | string | yes |  |
| GroupId | string | no |  |
| Concat | object | no |  |
| Whiteboard | object | no |  |
| MixStream | object | no |  |
| Extras | array | no |  |
| AudioFileNeeded | boolean | no |  |
| RecordControl | object | no |  |
| RecordMode | string | no |  |
| ChatGroupId | string | no |  |
| AutoStopTimeout | integer | no |  |
| ExtraData | string | no |  |
| TRTCRoomId | integer | no |  |
| TRTCRoomIdStr | string | no |  |

### Start Whiteboard Push
`POST https://apizie.tech/v1/cloud:tencent-tiw/start-whiteboard-push` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| SdkAppId | integer | yes |  |
| RoomId | integer | yes |  |
| PushUserId | string | yes |  |
| PushUserSig | string | yes |  |
| Whiteboard | object | no |  |
| AutoStopTimeout | integer | no |  |
| AutoManageBackup | boolean | no |  |
| Backup | object | no |  |
| PrivateMapKey | string | no |  |
| VideoFPS | integer | no |  |
| VideoBitrate | integer | no |  |
| AutoRecord | boolean | no |  |
| UserDefinedRecordId | string | no |  |
| AutoPublish | boolean | no |  |
| UserDefinedStreamId | string | no |  |
| ExtraData | string | no |  |
| TRTCRoomId | integer | no |  |
| TRTCRoomIdStr | string | no |  |
| IMAuthParam | object | no |  |
| TRTCAuthParam | object | no |  |
| TRTCEnterRoomMode | string | no |  |
| GroupId | string | no |  |

### Stop Online Record
`POST https://apizie.tech/v1/cloud:tencent-tiw/stop-online-record` (byok)

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

### Stop Whiteboard Push
`POST https://apizie.tech/v1/cloud:tencent-tiw/stop-whiteboard-push` (byok)

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

## Example
```
curl "https://apizie.tech/v1/cloud:tencent-tiw/create-pptcheck-task" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Tencent Cloud Interactive Whiteboard API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:tencent-tiw/create-pptcheck-task with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Tencent Cloud Interactive Whiteboard 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-tiw.

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