# tidb Chat2Data API

**Canonical:** https://apis.io/apis/pingcap/tidb-chat2data-api/  
**Provider:** PingCAP — https://apis.io/providers/pingcap/  
**Base URL:** https://data.tidbcloud.com/api/v1beta/app/{dataAppId}/endpoint  
**Documentation:** https://docs.pingcap.com/tidbcloud/api-overview/

tidb Chat2Data API is one of 45 APIs that [PingCAP](https://apis.io/providers/pingcap/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include Chat2Data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

Operations for translating natural language questions into SQL and executing them against TiDB Cloud clusters.

## Operations (4)

| Method | Path | Summary |
|---|---|---|
| POST | `/v3/chat2data` | Generate and execute SQL from natural language |
| POST | `/v3/suggestQuestions` | Suggest questions for a database |
| POST | `/v2/chat2data` | Generate and execute SQL from natural language (v2) |
| GET | `/v2/jobs/{job_id}` | Get job status |

## Machine-readable artifacts (10)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/pingcap/refs/heads/main/openapi/tidb-chat2data-api-openapi.yml
- **Documentation** — https://docs.pingcap.com/tidbcloud/api-overview/
- **Documentation** — https://docs.pingcap.com/tidbcloud/api/v1beta/
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pingcap/refs/heads/main/json-schema/tidb-cluster-schema.json
- **Documentation** — https://docs.pingcap.com/tidbcloud/data-service-overview/
- **Documentation** — https://docs.pingcap.com/tidbcloud/data-service-get-started/
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pingcap/refs/heads/main/json-schema/tidb-data-service-schema.json
- **Documentation** — https://docs.pingcap.com/tidbcloud/use-chat2query-api/
- **Documentation** — https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
- **Documentation** — https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/

## Other PingCAP APIs (12)

- [TiDB MCP Server](https://apis.io/apis/pingcap/tidb-mcp-server/)
- [PingCAP API Key API](https://apis.io/apis/pingcap/pingcap-api-key-api/)
- [PingCAP Audit Log API](https://apis.io/apis/pingcap/pingcap-audit-log-api/)
- [PingCAP Backup API](https://apis.io/apis/pingcap/pingcap-backup-api/)
- [PingCAP Billing API](https://apis.io/apis/pingcap/pingcap-billing-api/)
- [PingCAP Branch API](https://apis.io/apis/pingcap/pingcap-branch-api/)
- [PingCAP Changefeed API](https://apis.io/apis/pingcap/pingcap-changefeed-api/)
- [PingCAP Chat2 Query API](https://apis.io/apis/pingcap/pingcap-chat2query-api/)
- [PingCAP Cluster API](https://apis.io/apis/pingcap/pingcap-cluster-api/)
- [PingCAP Collections API](https://apis.io/apis/pingcap/pingcap-collections-api/)
- [PingCAP Data API Key API](https://apis.io/apis/pingcap/pingcap-data-api-key-api/)
- [PingCAP Data App API](https://apis.io/apis/pingcap/pingcap-data-app-api/)

## Tags

Chat2Data

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/pingcap/tidb-chat2data-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/pingcap/.