# Tencent Cloud Health Omics Platform API

> Tencent Cloud Health Omics Platform API on Apizie: 32 endpoints (Create Environment, Create Volume, Delete Environment, Delete Environment Cache, …) 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-omics/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Tencent Cloud API 3.0 for Health Omics Platform (omics). Every call is signed with TC3-HMAC-SHA256 using your SecretId and SecretKey.

## Endpoints

### Create Environment
`POST https://apizie.tech/v1/cloud:tencent-omics/create-environment` (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 |  |
| Config | object | yes |  |
| Description | string | no |  |
| IsDefault | boolean | no |  |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| EnvironmentId | string | yes |  |
| Name | string | yes |  |
| Type | string | yes |  |
| Spec | string | yes |  |
| Description | string | no |  |
| Capacity | integer | no |  |
| EnableAutoScaleUp | boolean | no |  |
| MetaType | string | no |  |

### Delete Environment
`POST https://apizie.tech/v1/cloud:tencent-omics/delete-environment` (byok)

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

### Delete Environment Cache
`POST https://apizie.tech/v1/cloud:tencent-omics/delete-environment-cache` (byok)

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

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

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

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

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

### Describe Application Versions
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-application-versions` (byok)

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

### Describe Applications
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-applications` (byok)

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

### Describe Environments
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-environments` (byok)

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

### Describe HPCClusters
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-hpcclusters` (byok)

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

### Describe HPCNodes
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-hpcnodes` (byok)

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

### Describe Input Templates
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-input-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ProjectId | string | no |  |
| Limit | integer | no |  |
| Offset | integer | no |  |
| Filters | array | no |  |
| ApplicationVersionId | string | no |  |
| ApplicationId | string | no |  |

### Describe Projects
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-projects` (byok)

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

### Describe Public Applications
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-public-applications` (byok)

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

### Describe Run Groups
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-run-groups` (byok)

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

### Describe Runs
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-runs` (byok)

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

### Describe Tables
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-tables` (byok)

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

### Describe Tables Rows
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-tables-rows` (byok)

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

### Describe Volumes
`POST https://apizie.tech/v1/cloud:tencent-omics/describe-volumes` (byok)

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

### Get Input Template File
`POST https://apizie.tech/v1/cloud:tencent-omics/get-input-template-file` (byok)

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

### Get Run Calls
`POST https://apizie.tech/v1/cloud:tencent-omics/get-run-calls` (byok)

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

### Get Run Job Log
`POST https://apizie.tech/v1/cloud:tencent-omics/get-run-job-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| RunUuid | string | yes |  |
| JobId | string | yes |  |
| LogType | string | yes |  |
| ProjectId | string | no |  |
| Path | string | no |  |

### Get Run Metadata File
`POST https://apizie.tech/v1/cloud:tencent-omics/get-run-metadata-file` (byok)

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

### Get Run Status
`POST https://apizie.tech/v1/cloud:tencent-omics/get-run-status` (byok)

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

### Import Common Application
`POST https://apizie.tech/v1/cloud:tencent-omics/import-common-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| CommonAppUuid | string | yes |  |
| CommonAppNewName | string | yes |  |
| ProjectId | string | yes |  |
| Type | string | yes |  |
| NextflowVersion | string | yes |  |
| Internal | boolean | no |  |

### Import Table File
`POST https://apizie.tech/v1/cloud:tencent-omics/import-table-file` (byok)

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

### Modify Volume
`POST https://apizie.tech/v1/cloud:tencent-omics/modify-volume` (byok)

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

### Reboot HPCNodes
`POST https://apizie.tech/v1/cloud:tencent-omics/reboot-hpcnodes` (byok)

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

### Retry Runs
`POST https://apizie.tech/v1/cloud:tencent-omics/retry-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ProjectId | string | no |  |
| RunGroupId | string | no |  |
| RunUuids | array | no |  |
| WDLOption | object | no |  |
| NFOption | object | no |  |

### Run Application
`POST https://apizie.tech/v1/cloud:tencent-omics/run-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ApplicationId | string | yes |  |
| Name | string | yes |  |
| EnvironmentId | string | yes |  |
| ProjectId | string | no |  |
| Description | string | no |  |
| InputCosUri | string | no |  |
| InputBase64 | string | no |  |
| TableId | string | no |  |
| TableRowUuids | array | no |  |
| CacheClearDelay | integer | no |  |
| ApplicationVersionId | string | no |  |
| Option | object | no |  |
| NFOption | object | no |  |
| WorkDir | string | no |  |
| AccessMode | string | no |  |
| VolumeIds | array | no |  |
| ResultNotification | boolean | no |  |
| TimeoutNotification | boolean | no |  |
| TimeoutNotificationMinutes | integer | no |  |
| EmailForNotification | array | no |  |

### Run Workflow
`POST https://apizie.tech/v1/cloud:tencent-omics/run-workflow` (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 |  |
| EnvironmentId | string | yes |  |
| GitSource | object | yes |  |
| Type | string | yes |  |
| NFOption | object | yes |  |
| ProjectId | string | no |  |
| Description | string | no |  |
| InputBase64 | string | no |  |
| InputCosUri | string | no |  |
| CacheClearDelay | integer | no |  |
| WorkDir | string | no |  |
| VolumeIds | array | no |  |
| Entrypoint | string | no |  |

### Terminate Run Group
`POST https://apizie.tech/v1/cloud:tencent-omics/terminate-run-group` (byok)

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

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

## FAQ

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

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

### Can AI agents use the Tencent Cloud Health Omics Platform 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-omics.

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