Cast AI Table Metadata API

openapi: 3.2.0
info:
  title: Database Optimizer Table Metadata API
  version: 0.0.1
  description: TableMetadataAPI provides operations for managing table metadata
servers:
- url: https://api.cast.ai/
  description: US endpoint
- url: https://api.eu.cast.ai/
  description: EU endpoint
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: TableMetadataAPI
  description: TableMetadataAPI provides operations for managing table metadata
paths:
  ? /database-optimizer/index-advisor/v1alpha/organizations/{organizationId}/cache-groups/{cacheGroupId}/databases/{databaseName}/mysql-table-metadata:batchCreate
  : post:
      tags:
      - TableMetadataAPI
      summary: Batch create MySQL table metadata from collector
      description: 'Batch create MySQL table metadata


        Stores MySQL table metadata that is used to identify index optimization opportunities'
      operationId: TableMetadataAPI_BatchCreateMySQLTablesMetadata
      parameters:
      - name: organizationId
        in: path
        description: Organization identifier
        required: true
        schema:
          type: string
      - name: cacheGroupId
        in: path
        description: Cache group ID
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        description: Database name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCreateMySQLTablesMetadataRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchCreateMySQLTablesMetadataResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  ? /database-optimizer/index-advisor/v1alpha/organizations/{organizationId}/cache-groups/{cacheGroupId}/databases/{databaseName}/table-metadata:batchCreate
  : post:
      tags:
      - TableMetadataAPI
      summary: Batch create table metadata for analysis
      description: 'Batch create table metadata


        Stores table metadata that is used to identify index optimization opportunities'
      operationId: TableMetadataAPI_BatchCreateTablesMetadata
      parameters:
      - name: organizationId
        in: path
        description: Organization identifier
        required: true
        schema:
          type: string
      - name: cacheGroupId
        in: path
        description: Cache group ID
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        description: Database name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCreateTablesMetadataRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchCreateTablesMetadataResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
components:
  schemas:
    Status:
      type: object
      properties:
        code:
          type: integer
          description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
          format: int32
        message:
          type: string
          description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/GoogleProtobufAny'
          description: A list of messages that carry the error details.  There is a common set of message types for APIs to use.
      description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
    BatchCreateTablesMetadataResponse:
      type: object
      properties: {}
      description: Response from batch creating execution plans
    MySQLTableMetadata:
      required:
      - schemaName
      - tableName
      - dataSizeBytes
      - indexSizeBytes
      type: object
      properties:
        schemaName:
          type: string
          description: Name of schema for the table
        tableName:
          type: string
          description: Name of the table
        dataSizeBytes:
          type: string
          description: Data size in bytes (from DATA_LENGTH)
        indexSizeBytes:
          type: string
          description: Index size in bytes (from INDEX_LENGTH)
      description: MySQL table metadata for a table
    BatchCreateTablesMetadataRequest:
      required:
      - organizationId
      - cacheGroupId
      - databaseName
      - requests
      type: object
      properties:
        organizationId:
          type: string
          description: Organization identifier
        cacheGroupId:
          type: string
          description: Cache group ID
        databaseName:
          type: string
          description: Database name
        parent:
          type: string
          description: "Optional parent resource path. If not provided, will be auto-populated\n from organization_id and database_id as \"organizations/{organization_id}/databases/{database_id}\"\n If provided, must match the individual organization_id and database_id fields."
        requests:
          type: array
          items:
            $ref: '#/components/schemas/TableMetadata'
          description: "The request messages specifying the execution plans to create.\n A maximum of 100 execution plans can be created in a batch."
        metadata:
          allOf:
          - $ref: '#/components/schemas/RequestMetadata'
          description: Request metadata
        databaseVersion:
          type: string
          description: Database server version
      description: Request to batch create table metadata (each element refers to a table)
    ColumnStats:
      required:
      - columnName
      - dataType
      - dataTypeCategory
      - distinctValues
      - correlation
      - nullFraction
      type: object
      properties:
        columnName:
          type: string
          description: Name of the column
        dataType:
          type: string
          description: Name of the column data type
        dataTypeCategory:
          type: string
          description: Character code for data type family
        distinctValues:
          type: number
          description: "Number of distinct values in the column (positive number if exact, otherwise a negative\n number is fractional estimate relative to table size.)"
          format: double
        correlation:
          type: number
          description: The statistical correlation between column values and their physical row order.
          format: double
        nullFraction:
          type: number
          description: Fraction of column entries/values that are null
          format: double
      description: Column statistics for a column in a table
    TableMetadata:
      required:
      - schemaName
      - tableName
      - estimatedRows
      - tableSizeBytes
      - columnStats
      type: object
      properties:
        schemaName:
          type: string
          description: Name of schema for the table
        tableName:
          type: string
          description: Name of the table
        estimatedRows:
          type: string
          description: The estimated rows in the table
        tableSizeBytes:
          type: string
          description: Size in bytes of the table
        columnStats:
          type: array
          items:
            $ref: '#/components/schemas/ColumnStats'
          description: Statistics for table columns
      description: Table metadata for a table
    BatchCreateMySQLTablesMetadataRequest:
      required:
      - organizationId
      - cacheGroupId
      - databaseName
      - requests
      type: object
      properties:
        organizationId:
          type: string
          description: Organization identifier
        cacheGroupId:
          type: string
          description: Cache group ID
        databaseName:
          type: string
          description: Database name
        requests:
          type: array
          items:
            $ref: '#/components/schemas/MySQLTableMetadata'
          description: "The request messages specifying the table metadata to create.\n A maximum of 100 items can be created in a batch."
        metadata:
          allOf:
          - $ref: '#/components/schemas/RequestMetadata'
          description: Request metadata
        databaseVersion:
          type: string
          description: Database server version
      description: Request to batch create MySQL table metadata
    BatchCreateMySQLTablesMetadataResponse:
      type: object
      properties: {}
      description: Response from batch creating MySQL table metadata
    RequestMetadata:
      type: object
      properties:
        requestId:
          type: string
          description: Request ID for tracing
        clientVersion:
          type: string
          description: Client version information
        collectorId:
          type: string
          description: Collection source identifier
        source:
          type: string
          description: Request source information
      description: Request metadata for tracing
    GoogleProtobufAny:
      type: object
      properties:
        '@type':
          type: string
          description: The type of the serialized message.
      additionalProperties: true
      description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
x-provenance:
  method: searched
  source: https://docs.cast.ai/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.cast.ai/reference/advisorapi_batchgetadvisordatabasestats.md
  - https://docs.cast.ai/reference/advisorapi_closeadvisorrecommendation.md
  - https://docs.cast.ai/reference/advisorapi_getadvisorcachegroup.md
  - https://docs.cast.ai/reference/advisorapi_getadvisordatabase.md
  - https://docs.cast.ai/reference/advisorapi_getadvisordatabaseinstance.md
  - https://docs.cast.ai/reference/advisorapi_getadvisorrecommendationdetail.md
  - https://docs.cast.ai/reference/advisorapi_listadvisorcachegroups.md
  - https://docs.cast.ai/reference/advisorapi_listadvisordatabaseinstances.md
  - https://docs.cast.ai/reference/advisorapi_listadvisordatabases.md
  - https://docs.cast.ai/reference/advisorapi_listadvisorrecommendations.md
  - https://docs.cast.ai/reference/advisorapi_listtoprecommendations.md
  - https://docs.cast.ai/reference/advisorapi_markadvisordbagentuninstalled.md
  - https://docs.cast.ai/reference/advisorapi_reopenadvisorrecommendation.md
  - https://docs.cast.ai/reference/advisorapi_resendadvisorvalidationrequest.md
  - https://docs.cast.ai/reference/advisorapi_resetadvisorrecommendations.md
  - https://docs.cast.ai/reference/cachegroupsapi_getindexadvisorcachegroup.md
  - https://docs.cast.ai/reference/cachegroupsapi_listindexadvisorcachegroups.md
  - https://docs.cast.ai/reference/cachegroupsapi_sendagentheartbeat.md
  - https://docs.cast.ai/reference/cachingapi_createcacherule.md
  - https://docs.cast.ai/reference/cachingapi_createproxy.md
  - https://docs.cast.ai/reference/cachingapi_deletecacherule.md
  - https://docs.cast.ai/reference/cachingapi_exchangeproxystate.md
  - https://docs.cast.ai/reference/cachingapi_getinstanceproxycachemetrics.md
  - https://docs.cast.ai/reference/cachingapi_getproxycachemetrics.md
  - https://docs.cast.ai/reference/cachingapi_getproxycachequeryinsights.md
  - https://docs.cast.ai/reference/cachingapi_getproxycachequerytemplate.md
  - https://docs.cast.ai/reference/cachingapi_getproxycachesummary.md
  - https://docs.cast.ai/reference/cachingapi_getproxyconnectionsmetrics.md
  - https://docs.cast.ai/reference/cachingapi_getproxyperformancemetrics.md
  - https://docs.cast.ai/reference/cachingapi_getproxyqueries.md
  - https://docs.cast.ai/reference/cachingapi_listcacherules.md
  - https://docs.cast.ai/reference/cachingapi_reportoperationalmetrics.md
  - https://docs.cast.ai/reference/cachingapi_reportpoolingmetrics.md
  - https://docs.cast.ai/reference/cachingapi_reportquerymetrics.md
  - https://docs.cast.ai/reference/cachingapi_updatecacherule.md
  - https://docs.cast.ai/reference/cachingapi_updateproxydatabase.md
  - https://docs.cast.ai/reference/databaseinstanceconfigapi_reportdatabaseinstanceconfig.md
  - https://docs.cast.ai/reference/databaseinstancesapi_createdatabase.md
  - https://docs.cast.ai/reference/databaseinstancesapi_createdatabaseinstance.md
  - https://docs.cast.ai/reference/databaseinstancesapi_deletedatabase.md
  - https://docs.cast.ai/reference/databaseinstancesapi_deletedatabaseinstance.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getcloudsyncstatus.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabase.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabaseinstancecachingsummary.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabaseinstancedetails.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabaseinstancehealthmetrics.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabaseinstancemetricsfilteroptions.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabaseinstancescloudintegrationsummary.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listcachingpotentialdatabases.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listcloudoptimizationcandidates.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listconnectionpoolingcandidates.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listdatabaseinstancemembers.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listdatabaseinstances.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listtopqueryrecommendations.md
  - https://docs.cast.ai/reference/databaseinstancesapi_updatedatabaseinstance.md
  - https://docs.cast.ai/reference/databasesapi_getcachedatabase.md
  - https://docs.cast.ai/reference/databasesapi_listcachedatabases.md
  - https://docs.cast.ai/reference/dbagentapi_ingestagentheartbeat.md
  - https://docs.cast.ai/reference/dbagentapi_ingestmysqlindexsnapshots.md
  - https://docs.cast.ai/reference/dbagentapi_ingestmysqlquerystats.md
  - https://docs.cast.ai/reference/dbagentapi_ingestmysqltablesmetadata.md
  - https://docs.cast.ai/reference/dbagentapi_ingestpostgresindexsnapshots.md
  - https://docs.cast.ai/reference/dbagentapi_ingestpostgresquerystats.md
  - https://docs.cast.ai/reference/dbagentapi_ingestpostgrestablesmetadata.md
  - https://docs.cast.ai/reference/indexrecommendationsapi_listindexrecommendations.md
  - https://docs.cast.ai/reference/indexsnapshotsapi_batchcreateindexsnapshots.md
  - https://docs.cast.ai/reference/indexsnapshotsapi_batchcreatemysqlindexsnapshots.md
  - https://docs.cast.ai/reference/querystatsapi_batchcreatemysqlquerystats.md
  - https://docs.cast.ai/reference/querystatsapi_batchcreatepgquerystats.md
  - https://docs.cast.ai/reference/querystatsapi_batchcreatequerystats.md
  - https://docs.cast.ai/reference/tablemetadataapi_batchcreatemysqltablesmetadata.md
  - https://docs.cast.ai/reference/tablemetadataapi_batchcreatetablesmetadata.md
  - https://docs.cast.ai/reference/telemetryapi_ingesttelemetryevents.md
  - https://docs.cast.ai/reference/telemetryapi_listtelemetryevents.md
  merge:
    pages: 74
    deduped: 412
    conflicts_kept_first: 0