tidb website screenshot

tidb

TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing workloads, with horizontal scalability, strong consistency, and high availability.

tidb publishes 23 APIs on the APIs.io network, including API Keys API, Audit Logs API, Billing API, and 20 more.

The tidb catalog on APIs.io includes 1 JSON-LD context and 1 Spectral governance ruleset.

tidb’s developer surface includes authentication and 8 more developer resources.

🌐 Visit website 📡 Source on GitHub
47.1/100 developing ▬ flat Agent 34/100 agent ready Full breakdown ↓
scored 2026-08-05 · rubric v0.9.1
AccessFreemiumSelf serve⚡ Free to try
23 APIs

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-08-05 · rubric v0.9.1
Composite quality — 47.1/100 · developing
Contract Quality 19.7 / 25
Developer Ergonomics 2.2 / 20
Commercial Clarity 7.9 / 20
Operational Transparency 4.1 / 13
Governance 8.3 / 12
Discoverability 5.0 / 10
Agent readiness — 34/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 4 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/tidb: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 23

Individual APIs this provider publishes, each with its own machine-readable definition.

tidb API Keys API

Operations for creating, listing, updating, and deleting TiDB Cloud API keys.

tidb Audit Logs API

Operations for retrieving organization-level console audit logs.

tidb Billing API

Operations for retrieving monthly billing summaries, cost details, and usage trends.

tidb Chat2Data API

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

tidb Clusters API

Operations for creating, listing, updating, and deleting TiDB Cloud Dedicated clusters.

tidb Data App API Keys API

Operations for managing API keys scoped to a specific Data App.

tidb Data Apps API

Operations for creating, listing, updating, and deleting Data Apps.

tidb Data Sources API

Operations for linking and managing TiDB Cloud clusters as data sources within a Data App.

tidb Data Summaries API

Operations for generating and managing AI summaries of database schemas used as context for SQL generation.

tidb DDL API

Endpoints for managing and inspecting DDL jobs, including ownership and history.

tidb Deployments API

Operations for deploying and managing versions of a Data App.

tidb Diagnostics API

Endpoints for downloading debug information and managing server diagnostics.

tidb Endpoints API

Operations for creating, listing, updating, testing, and deleting custom SQL-backed API endpoints.

tidb Imports API

Operations for creating and managing data import tasks into TiDB Cloud clusters.

tidb Integrations API

Operations for managing third-party integrations with TiDB Cloud clusters.

tidb MVCC API

Endpoints for retrieving multi-version concurrency control (MVCC) key details for debugging.

tidb Regions API

Operations for listing available cloud regions and node specifications.

tidb Schema API

Endpoints for retrieving database and table schema information from the TiDB information schema.

tidb Sessions API

Operations for creating and managing multi-round conversational chat sessions.

tidb Settings API

Endpoints for retrieving and modifying TiDB server runtime settings.

tidb SQL Refinement API

Operations for refining and improving previously generated SQL queries.

tidb Statistics API

Endpoints for exporting optimizer statistics used for query planning.

tidb Status API

Endpoints for retrieving the operational status of the TiDB server instance.

Scroll for all 23

Open Collections 4

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

TiDB Cloud API

OPEN COLLECTION

TiDB Cloud Chat2Query API

OPEN COLLECTION

TiDB Cloud Data Service API

OPEN COLLECTION

TiDB HTTP API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Tidb Plans Pricing

6 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Tidb Rate Limits

4 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Tidb Finops

FINOPS

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Tidb Context

0 classes · 16 properties

JSON-LD

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

tidb API Rules

6 rules · 4 warnings 2 info

SPECTRAL

JSON Schema 2

Standalone JSON Schema definitions for this provider's data models.

TiDB Cloud Cluster

14 properties

JSON SCHEMA

TiDB Cloud Data Service

6 properties

JSON SCHEMA

JSON Structure 1

JSON Structure definitions describing this provider's data shapes.

Tidb Cluster Structure

0 properties

JSON STRUCTURE

Examples 3

Example request and response payloads for these APIs.

Tidb Cloud Api List Clusters Example

2 fields

EXAMPLE

Tidb Cloud Chat2Query Example

2 fields

EXAMPLE

Tidb Http Api Get Status Example

2 fields

EXAMPLE

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Tidb Authentication

http · 1 scheme

SECURITY

Tidb Domain Security

TLSv1.3 · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Tidb Agentic Access

74 operations · 32 acting · 1 human-in-the-loop

74 operations · 32 acting

AGENTIC

Resources

Documentation 2

Reference material describing how the API behaves

JSONSchema
JSONSchema
 JSONSchema
JSONSchema

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess

Design & Contract 3

Pagination, idempotency, versioning, errors, and events

JSONLD
JSONLD
 Spectral
Spectral
 Vocabulary
Vocabulary

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity
DomainSecurity
 Authentication
Authentication

Company 1

The organization behind the API

LinkedIn
LinkedIn

Source (apis.yml)

apis.yml Raw ↑ 
aid: tidb
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/tidb.png
url: https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/apis.yml
apis:
- aid: tidb:tidb-api-keys-api
  name: tidb API Keys API
  description: Operations for creating, listing, updating, and deleting TiDB Cloud API keys.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - API Keys
  properties:
  - type: OpenAPI
    url: openapi/tidb-api-keys-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-audit-logs-api
  name: tidb Audit Logs API
  description: Operations for retrieving organization-level console audit logs.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Audit Logs
  properties:
  - type: OpenAPI
    url: openapi/tidb-audit-logs-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-billing-api
  name: tidb Billing API
  description: Operations for retrieving monthly billing summaries, cost details, and usage trends.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Billing
  properties:
  - type: OpenAPI
    url: openapi/tidb-billing-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-chat2data-api
  name: tidb Chat2Data API
  description: Operations for translating natural language questions into SQL and executing them against TiDB Cloud clusters.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Chat2Data
  properties:
  - type: OpenAPI
    url: openapi/tidb-chat2data-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-clusters-api
  name: tidb Clusters API
  description: Operations for creating, listing, updating, and deleting TiDB Cloud Dedicated clusters.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Clusters
  properties:
  - type: OpenAPI
    url: openapi/tidb-clusters-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-data-app-api-keys-api
  name: tidb Data App API Keys API
  description: Operations for managing API keys scoped to a specific Data App.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Data App API Keys
  properties:
  - type: OpenAPI
    url: openapi/tidb-data-app-api-keys-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-data-apps-api
  name: tidb Data Apps API
  description: Operations for creating, listing, updating, and deleting Data Apps.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Data Apps
  properties:
  - type: OpenAPI
    url: openapi/tidb-data-apps-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-data-sources-api
  name: tidb Data Sources API
  description: Operations for linking and managing TiDB Cloud clusters as data sources within a Data App.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Data Sources
  properties:
  - type: OpenAPI
    url: openapi/tidb-data-sources-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-data-summaries-api
  name: tidb Data Summaries API
  description: Operations for generating and managing AI summaries of database schemas used as context for SQL generation.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Data Summaries
  properties:
  - type: OpenAPI
    url: openapi/tidb-data-summaries-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-ddl-api
  name: tidb DDL API
  description: Endpoints for managing and inspecting DDL jobs, including ownership and history.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - DDL
  properties:
  - type: OpenAPI
    url: openapi/tidb-ddl-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-deployments-api
  name: tidb Deployments API
  description: Operations for deploying and managing versions of a Data App.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Deployments
  properties:
  - type: OpenAPI
    url: openapi/tidb-deployments-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-diagnostics-api
  name: tidb Diagnostics API
  description: Endpoints for downloading debug information and managing server diagnostics.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Diagnostics
  properties:
  - type: OpenAPI
    url: openapi/tidb-diagnostics-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-endpoints-api
  name: tidb Endpoints API
  description: Operations for creating, listing, updating, testing, and deleting custom SQL-backed API endpoints.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Endpoints
  properties:
  - type: OpenAPI
    url: openapi/tidb-endpoints-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-imports-api
  name: tidb Imports API
  description: Operations for creating and managing data import tasks into TiDB Cloud clusters.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Imports
  properties:
  - type: OpenAPI
    url: openapi/tidb-imports-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-integrations-api
  name: tidb Integrations API
  description: Operations for managing third-party integrations with TiDB Cloud clusters.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Integrations
  properties:
  - type: OpenAPI
    url: openapi/tidb-integrations-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-mvcc-api
  name: tidb MVCC API
  description: Endpoints for retrieving multi-version concurrency control (MVCC) key details for debugging.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - MVCC
  properties:
  - type: OpenAPI
    url: openapi/tidb-mvcc-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-regions-api
  name: tidb Regions API
  description: Operations for listing available cloud regions and node specifications.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Regions
  properties:
  - type: OpenAPI
    url: openapi/tidb-regions-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-schema-api
  name: tidb Schema API
  description: Endpoints for retrieving database and table schema information from the TiDB information schema.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Schema
  properties:
  - type: OpenAPI
    url: openapi/tidb-schema-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-sessions-api
  name: tidb Sessions API
  description: Operations for creating and managing multi-round conversational chat sessions.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Sessions
  properties:
  - type: OpenAPI
    url: openapi/tidb-sessions-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-settings-api
  name: tidb Settings API
  description: Endpoints for retrieving and modifying TiDB server runtime settings.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Settings
  properties:
  - type: OpenAPI
    url: openapi/tidb-settings-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-sql-refinement-api
  name: tidb SQL Refinement API
  description: Operations for refining and improving previously generated SQL queries.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - SQL Refinement
  properties:
  - type: OpenAPI
    url: openapi/tidb-sql-refinement-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-statistics-api
  name: tidb Statistics API
  description: Endpoints for exporting optimizer statistics used for query planning.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Statistics
  properties:
  - type: OpenAPI
    url: openapi/tidb-statistics-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
- aid: tidb:tidb-status-api
  name: tidb Status API
  description: Endpoints for retrieving the operational status of the TiDB server instance.
  humanURL: https://docs.pingcap.com/tidbcloud/api-overview/
  baseURL: https://api.tidbcloud.com
  tags:
  - Status
  properties:
  - type: OpenAPI
    url: openapi/tidb-status-api-openapi.yml
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: JSONSchema
    url: json-schema/tidb-cluster-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-overview/
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/data-service-get-started/
  - type: JSONSchema
    url: json-schema/tidb-data-service-schema.json
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/use-chat2query-api/
  - type: Documentation
    url: https://github.com/pingcap/tidb/blob/master/docs/tidb_http_api.md
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/tidb-monitoring-api/
common:
- type: AgenticAccess
  url: agentic-access/tidb-agentic-access.yml
- type: DomainSecurity
  url: security/tidb-domain-security.yml
- type: Authentication
  url: authentication/tidb-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/pingcap
- type: JSONLD
  url: json-ld/tidb-context.jsonld
- type: JSONSchema
  url: json-schema/tidb-cluster-schema.json
- type: JSONSchema
  url: json-schema/tidb-data-service-schema.json
- type: Spectral
  url: rules/tidb-rules.yml
- type: Vocabulary
  url: vocabulary/tidb-vocabulary.yml
modified: '2026-05-19'
description: TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing
  workloads, with horizontal scalability, strong consistency, and high availability.