Altimate AI Copilot API

openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS Copilot API
  version: 0.1.0
tags:
- name: Copilot
paths:
  /copilot/tasks:
    post:
      tags:
      - Copilot
      summary: Create Tasks
      description: 'Gets all violations.

        - table_id: search parameter'
      operationId: create_tasks_copilot_tasks_post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopilotPlanInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CopilotPlanOutput'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Create Tasks Copilot Tasks Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Create Tasks Copilot Tasks Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/session:
    post:
      tags:
      - Copilot
      summary: Create Session
      description: 'Gets all violations.

        - table_id: search parameter'
      operationId: create_session_copilot_session_post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopilotSessionInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CopilotSessionOutput'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Create Session Copilot Session Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Create Session Copilot Session Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Copilot
      summary: Get Session History
      description: 'Gets all violations.

        - table_id: search parameter'
      operationId: get_session_history_copilot_session_get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response Get Session History Copilot Session Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Session History Copilot Session Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Session History Copilot Session Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/session/{session_id}:
    post:
      tags:
      - Copilot
      summary: Chat
      description: 'Gets all violations.

        - table_id: search parameter'
      operationId: chat_copilot_session__session_id__post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatSessionOutput'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Chat Copilot Session  Session Id  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Chat Copilot Session  Session Id  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Copilot
      summary: Complete Chat
      description: 'Gets all violations.

        - table_id: search parameter'
      operationId: complete_chat_copilot_session__session_id__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatSessionState'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Complete Chat Copilot Session  Session Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Complete Chat Copilot Session  Session Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/tables:
    get:
      tags:
      - Copilot
      summary: Get Tables
      description: 'Gets all violations.

        - table_id: search parameter'
      operationId: get_tables_copilot_tables_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response Get Tables Copilot Tables Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Tables Copilot Tables Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Tables Copilot Tables Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/quickchat/query-explain/{query_id}:
    get:
      tags:
      - Copilot
      summary: Quick Explain Query
      operationId: quick_explain_query_copilot_quickchat_query_explain__query_id__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          title: Query Id
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Quick Explain Query Copilot Quickchat Query Explain  Query Id  Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Quick Explain Query Copilot Quickchat Query Explain  Query Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Quick Explain Query Copilot Quickchat Query Explain  Query Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/quickchat/query-explain/v2/{query_id}:
    get:
      tags:
      - Copilot
      summary: Quick Explain Query V2
      operationId: quick_explain_query_v2_copilot_quickchat_query_explain_v2__query_id__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          title: Query Id
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Quick Explain Query V2 Copilot Quickchat Query Explain V2  Query Id  Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Quick Explain Query V2 Copilot Quickchat Query Explain V2  Query Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Quick Explain Query V2 Copilot Quickchat Query Explain V2  Query Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/quickchat/query-group-explain/{query_hash}:
    get:
      tags:
      - Copilot
      summary: Quick Explain Query Group
      operationId: quick_explain_query_group_copilot_quickchat_query_group_explain__query_hash__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_hash
        in: path
        required: true
        schema:
          type: string
          title: Query Hash
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Quick Explain Query Group Copilot Quickchat Query Group Explain  Query Hash  Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Quick Explain Query Group Copilot Quickchat Query Group Explain  Query Hash  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Quick Explain Query Group Copilot Quickchat Query Group Explain  Query Hash  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/quickchat/query-group-explain/v2/{query_hash}:
    get:
      tags:
      - Copilot
      summary: Quick Explain Query Group V2
      operationId: quick_explain_query_group_v2_copilot_quickchat_query_group_explain_v2__query_hash__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_hash
        in: path
        required: true
        schema:
          type: string
          title: Query Hash
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Quick Explain Query Group V2 Copilot Quickchat Query Group Explain V2  Query Hash  Get
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Quick Explain Query Group V2 Copilot Quickchat Query Group Explain V2  Query Hash  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Quick Explain Query Group V2 Copilot Quickchat Query Group Explain V2  Query Hash  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/process_inputs:
    post:
      tags:
      - Copilot
      summary: Process Inputs
      description: Processes workflow inputs
      operationId: process_inputs_copilot_process_inputs_post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopilotProcessInputsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CopilotProcessInputsResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Process Inputs Copilot Process Inputs Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Process Inputs Copilot Process Inputs Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/quickchat/query-analysis/v2/{query_id}:
    post:
      tags:
      - Copilot
      summary: Analyze Query V2
      description: "Analyze a SQL query and provide optimization recommendations\n\nArgs:\n    query_id: The query ID to analyze\n    model_type: The model to use for analysis (CLAUDE or DEEPSEEK)\n    instance_id: The Snowflake instance ID"
      operationId: analyze_query_v2_copilot_quickchat_query_analysis_v2__query_id__post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          title: Query Id
      - name: model_type
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/ModelType'
          default: claude
      - name: instance_id
        in: query
        required: false
        schema:
          type: string
          title: Instance Id
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Analyze Query V2 Copilot Quickchat Query Analysis V2  Query Id  Post
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Analyze Query V2 Copilot Quickchat Query Analysis V2  Query Id  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Analyze Query V2 Copilot Quickchat Query Analysis V2  Query Id  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/quickchat/table-analysis/v2/{table_name}:
    post:
      tags:
      - Copilot
      summary: Analyze Table V2
      description: "Analyze a Snowflake table and provide optimization recommendations\n\nArgs:\n    table_name: The complete table name (db.schema.table)\n    model_type: The model to use for analysis (CLAUDE or DEEPSEEK)\n    instance_id: The Snowflake instance ID"
      operationId: analyze_table_v2_copilot_quickchat_table_analysis_v2__table_name__post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_name
        in: path
        required: true
        schema:
          type: string
          title: Table Name
      - name: model_type
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/ModelType'
          default: claude
      - name: instance_id
        in: query
        required: false
        schema:
          type: string
          title: Instance Id
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Analyze Table V2 Copilot Quickchat Table Analysis V2  Table Name  Post
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Analyze Table V2 Copilot Quickchat Table Analysis V2  Table Name  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Analyze Table V2 Copilot Quickchat Table Analysis V2  Table Name  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/quickchat/query-analysis/v2/plain/{query_id}:
    post:
      tags:
      - Copilot
      summary: Analyze Query V2
      description: "Analyze a SQL query and provide optimization recommendations\n\nArgs:\n    query_id: The query ID to analyze\n    model_type: The model to use for analysis (CLAUDE or DEEPSEEK)\n    instance_id: The Snowflake instance ID"
      operationId: analyze_query_v2_copilot_quickchat_query_analysis_v2_plain__query_id__post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          title: Query Id
      - name: model_type
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/ModelType'
          default: claude
      - name: instance_id
        in: query
        required: false
        schema:
          type: string
          title: Instance Id
      - name: include_sql
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Include Sql
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Analyze Query V2 Copilot Quickchat Query Analysis V2 Plain  Query Id  Post
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Analyze Query V2 Copilot Quickchat Query Analysis V2 Plain  Query Id  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Analyze Query V2 Copilot Quickchat Query Analysis V2 Plain  Query Id  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/quickchat/table-analysis/v2/plain/{table_name}:
    post:
      tags:
      - Copilot
      summary: Analyze Table V2
      description: "Analyze a SQL query and provide optimization recommendations\n\nArgs:\n    query_id: The query ID to analyze\n    model_type: The model to use for analysis (CLAUDE or DEEPSEEK)\n    instance_id: The Snowflake instance ID"
      operationId: analyze_table_v2_copilot_quickchat_table_analysis_v2_plain__table_name__post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: table_name
        in: path
        required: true
        schema:
          type: string
          title: Table Name
      - name: model_type
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/ModelType'
          default: claude
      - name: instance_id
        in: query
        required: false
        schema:
          type: string
          title: Instance Id
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Analyze Table V2 Copilot Quickchat Table Analysis V2 Plain  Table Name  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Analyze Table V2 Copilot Quickchat Table Analysis V2 Plain  Table Name  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/quickchat/query-static-analysis:
    post:
      tags:
      - Copilot
      summary: Analyze Query Static Endpoint
      description: "Perform static analysis on a SQL query without executing it.\n\nThis endpoint analyzes the query structure to identify potential issues\nsuch as SELECT *, functions in JOIN/filter conditions, missing LIMIT,\nand Cartesian products.\n\nArgs:\n    request: Contains the SQL query and optional dialect (default: snowflake)\n\nReturns:\n    Analysis results with identified issues and recommendations"
      operationId: analyze_query_static_endpoint_copilot_quickchat_query_static_analysis_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StaticQueryAnalysisRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StaticQueryAnalysisResponse'
        '400':
          description: Invalid SQL query
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Analyze Query Static Endpoint Copilot Quickchat Query Static Analysis Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Analyze Query Static Endpoint Copilot Quickchat Query Static Analysis Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/quickchat/table-metadata:
    post:
      tags:
      - Copilot
      summary: Get Table Metadata Endpoint
      description: "Get comprehensive table metadata, statistics, and clustering information.\n\nThis endpoint provides all data needed for table optimization analysis:\n- Table metadata (schema, columns, data types)\n- Table statistics (storage, read/write counts, costs)\n- Clustering information (if clustering keys exist)\n\nArgs:\n    request: Contains fully_qualified_names (list of database.schema.table)\n             and optional instance_id\n\nReturns:\n    Dictionary with table names as keys and optimization data as values"
      operationId: get_table_metadata_endpoint_copilot_quickchat_table_metadata_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TableMetadataRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid table name
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Table Metadata Endpoint Copilot Quickchat Table Metadata Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Table Metadata Endpoint Copilot Quickchat Table Metadata Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /copilot/quickchat/query-optimization-guide:
    get:
      tags:
      - Copilot
      summary: Get Query Optimization Guide Endpoint
      description: 'Get the query optimization guide for a specific SQL dialect.


        This endpoint returns best practices, workflow guidelines, and anti-patterns

        to avoid when optimizing queries.'
      operationId: get_query_optimization_guide_endpoint_copilot_quickchat_query_optimization_guide_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: dialect
        in: query
        required: false
        schema:
          type: string
          description: SQL dialect (currently only snowflake supported)
          default: snowflake
          title: Dialect
        description: SQL dialect (currently only snowflake supported)
      - name: x-tenant
        in: header
        required: false
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: R

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/altimate-ai/refs/heads/main/openapi/altimate-ai-copilot-api-openapi.yml