How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

tidb Chat2Data API

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

tidb Chat2Data API is one of 23 APIs that Tidb publishes on the 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.

This API exposes 4 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version v3.

Requests are made against a single base URL, https://data.tidbcloud.com/api/v1beta/app/{dataAppId}/endpoint.

4 operations 4 paths 9 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3
Base URL
https://api.tidbcloud.com
Authentication
HTTP Digest
Terms of Service
Resource Areas
1

Authentication & Security 1

tidb Chat2Data API declares 1 security scheme for authenticating requests. It uses HTTP digest authentication (digestAuth). By default, every request must be authenticated.

  • digestAuth — HTTP Digest Authentication using a Chat2Query Data App API public key as the username and private key as the password. Keys are generated within the Chat2Query…

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Chat2Data 4

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

POST
/v3/chat2data
Generate and execute SQL from natural language
generateAndExecuteSql body → 200400401429
POST
/v3/suggestQuestions
Suggest questions for a database
suggestQuestions body → 200400401429
POST
/v2/chat2data
Generate and execute SQL from natural language (v2)
generateAndExecuteSqlV2 body → 200400401429
GET
/v2/jobs/{job_id}
Get job status
getJobStatus 1 param → 200401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Chat2DataRequest (6 properties), Chat2DataResult (4 properties), ColumnDefinition (3 properties), Chat2DataResponse (3 properties). Each schema is shown below with its type and property counts.

JobStatusResponse
object
Status and result of an asynchronous Chat2Query v2 job.
3 properties
JobResponse
object
Response for asynchronous v2 Chat2Query job creation.
3 properties
Chat2DataResult
object
The result of a Chat2Data SQL generation and execution.
4 properties
ErrorResponse
object
Standard error response returned when an API request fails.
2 properties
SuggestQuestionsRequest
object
Request body for generating question suggestions for a database.
2 properties 2 required
ColumnDefinition
object
A column definition in a query result set.
3 properties
SuggestQuestionsResponse
object
API response wrapper for question suggestions.
3 properties
Chat2DataResponse
object
API response wrapper for a Chat2Data operation.
3 properties
Chat2DataRequest
object
Request body for generating and executing a SQL query from natural language.
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tidb-chat2data-api-openapi.yml Raw ↑

Other APIs Tidb publishes across the network.

tidb API Keys API
tidb Audit Logs API
tidb Billing API
tidb Clusters API
tidb Data App API Keys API
tidb Data Apps API
tidb Data Sources API
tidb Data Summaries API
tidb DDL API
tidb Deployments API
tidb Diagnostics API
tidb Endpoints API
Where this information came from

This is an independent, third-party profile of tidb Chat2Data API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.