{
  "opencollection": "1.0.0",
  "info": {
    "name": "TiDB Cloud API Keys Data Summaries API",
    "version": "v1beta1"
  },
  "items": [
    {
      "info": {
        "name": "Data Summaries",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List data summaries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dedicated.tidbapi.com/v1beta1/v3/dataSummaries"
          },
          "docs": "Returns all AI-generated data summaries for the Chat2Query Data App. A data summary captures the schema structure and statistical profile of a database, providing context that the AI uses to generate more accurate SQL statements. Summaries must be created before calling the chat2data endpoint with a data_summary_id."
        },
        {
          "info": {
            "name": "Create a data summary",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dedicated.tidbapi.com/v1beta1/v3/dataSummaries",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generates an AI-powered summary of the specified database schema on a linked TiDB Cloud cluster. The summary analyzes table structures, relationships, and data distributions to provide context for subsequent SQL generation. Set reuse to true to return an existing summary if one already exists for this database."
        },
        {
          "info": {
            "name": "Get a data summary",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dedicated.tidbapi.com/v1beta1/v3/dataSummaries/:data_summary_id",
            "params": [
              {
                "name": "data_summary_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the data summary."
              }
            ]
          },
          "docs": "Returns the details and current generation status of a specific data summary by its ID. Data summary generation is asynchronous; poll this endpoint until the status is DONE before using the summary_id in a chat2data request."
        },
        {
          "info": {
            "name": "Update a data summary",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dedicated.tidbapi.com/v1beta1/v3/dataSummaries/:data_summary_id",
            "params": [
              {
                "name": "data_summary_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the data summary."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Regenerates or updates an existing data summary for a database. Use this endpoint to refresh a summary after significant schema or data changes to keep AI-generated SQL accurate."
        },
        {
          "info": {
            "name": "Create a data summary (v2)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dedicated.tidbapi.com/v1beta1/v2/dataSummaries",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generates a data summary of the specified database schema using the v2 Chat2Query API. This is the v2 version of the data summary endpoint. The v3 endpoint is recommended for new integrations as it supports additional features including knowledge bases and session management."
        }
      ]
    }
  ],
  "bundled": true
}