openapi: 3.0.3
info:
  title: Alation Data Catalog Aggregated Context API
  description: REST API for managing data sources, schemas, tables, and catalog objects in the Alation data intelligence platform. Supports metadata retrieval, custom field updates, and catalog object management.
  version: 1.0.0
  contact:
    name: Alation Developer Support
    url: https://developer.alation.com
servers:
- url: https://{instance}/integration/v2
  description: Alation instance
  variables:
    instance:
      default: your-alation-instance.com
      description: Your Alation instance hostname
security:
- BearerToken: []
tags:
- name: Aggregated Context
  description: Retrieve aggregated context for AI applications
paths:
  /aggregated_context/:
    post:
      operationId: getAggregatedContext
      summary: Get aggregated context
      description: Retrieves relevant catalog context for a given query or set of objects, optimized for AI and LLM consumption.
      tags:
      - Aggregated Context
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContextRequest'
      responses:
        '200':
          description: Aggregated context
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContextResponse'
        '400':
          description: Invalid request
components:
  schemas:
    ContextRequest:
      type: object
      required:
      - query
      properties:
        query:
          type: string
          description: Natural language query for context retrieval
        object_types:
          type: array
          items:
            type: string
          description: Filter results by object types
        limit:
          type: integer
          default: 10
    ContextResponse:
      type: object
      properties:
        context:
          type: array
          items:
            type: object
            properties:
              object_type:
                type: string
              object_id:
                type: integer
              title:
                type: string
              description:
                type: string
              metadata:
                type: object
                additionalProperties: true
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      description: API access token obtained from /integration/v1/createRefreshToken/