# Tencent Cloud Elasticsearch Service API

> Tencent Cloud Elasticsearch Service API on Apizie: 10 endpoints (Chat Completions, Chunk Document, Chunk Document Async, Get Document Chunk Result, …) 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-es/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

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

## Endpoints

### Chat Completions
`POST https://apizie.tech/v1/cloud:tencent-es/chat-completions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Messages | array | yes |  |
| ModelName | string | yes |  |
| Stream | boolean | no |  |
| TopP | number | no |  |
| Temperature | number | no |  |
| OnlineSearch | boolean | no |  |
| OnlineSearchOptions | object | no |  |
| Tools | array | no |  |
| ToolChoice | string | no |  |
| CustomTool | object | no |  |

### Chunk Document
`POST https://apizie.tech/v1/cloud:tencent-es/chunk-document` (byok)

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

### Chunk Document Async
`POST https://apizie.tech/v1/cloud:tencent-es/chunk-document-async` (byok)

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

### Get Document Chunk Result
`POST https://apizie.tech/v1/cloud:tencent-es/get-document-chunk-result` (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 |  |

### Get Document Parse Result
`POST https://apizie.tech/v1/cloud:tencent-es/get-document-parse-result` (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 |  |

### Get Multi Modal Embedding
`POST https://apizie.tech/v1/cloud:tencent-es/get-multi-modal-embedding` (byok)

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

### Get Text Embedding
`POST https://apizie.tech/v1/cloud:tencent-es/get-text-embedding` (byok)

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

### Parse Document
`POST https://apizie.tech/v1/cloud:tencent-es/parse-document` (byok)

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

### Parse Document Async
`POST https://apizie.tech/v1/cloud:tencent-es/parse-document-async` (byok)

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

### Run Rerank
`POST https://apizie.tech/v1/cloud:tencent-es/run-rerank` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ModelName | string | yes |  |
| Query | string | yes |  |
| Documents | array | yes |  |
| TopN | integer | no |  |
| ReturnDocuments | boolean | no |  |

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

## FAQ

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

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

### Can AI agents use the Tencent Cloud Elasticsearch Service 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-es.

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