Altimate AI DBT_V4 API

The DBT_V4 API from Altimate AI — 4 operation(s) for dbt_v4.

OpenAPI Specification

altimate-ai-dbt-v4-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS DBT_V4 API
  version: 0.1.0
tags:
- name: DBT_V4
paths:
  /dbt/v4/lineage:
    post:
      tags:
      - DBT_V4
      summary: Get Column Level Lineage
      description: Generates lineage analysis for a dbt_model
      operationId: get_column_level_lineage_dbt_v4_lineage_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DBTColumnLineageRequestV4'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DBTColumnLineageResponseV4'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Column Level Lineage Dbt V4 Lineage Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Column Level Lineage Dbt V4 Lineage Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dbt/v4/bulk-docs-prop-credits:
    post:
      tags:
      - DBT_V4
      summary: Post Bulk Docs Prop Credits
      operationId: post_bulk_docs_prop_credits_dbt_v4_bulk_docs_prop_credits_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkDocsPropCreditRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Post Bulk Docs Prop Credits Dbt V4 Bulk Docs Prop Credits Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Post Bulk Docs Prop Credits Dbt V4 Bulk Docs Prop Credits Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dbt/v4/export-lineage:
    post:
      tags:
      - DBT_V4
      summary: Post Export Lineage
      operationId: post_export_lineage_dbt_v4_export_lineage_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportLineageRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardUrlResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Post Export Lineage Dbt V4 Export Lineage Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Post Export Lineage Dbt V4 Export Lineage Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - DBT_V4
      summary: Get Export Lineage
      operationId: get_export_lineage_dbt_v4_export_lineage_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number
          default: 1
          title: Page
        description: Page number
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Page size
          default: 50
          title: Size
        description: Page size
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_ExportLineageResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Export Lineage Dbt V4 Export Lineage Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Export Lineage Dbt V4 Export Lineage Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /dbt/v4/export-lineage/{item_id}:
    delete:
      tags:
      - DBT_V4
      summary: Delete Export Lineage
      operationId: delete_export_lineage_dbt_v4_export_lineage__item_id__delete
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: item_id
        in: path
        required: true
        schema:
          type: integer
          title: Item Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Delete Export Lineage Dbt V4 Export Lineage  Item Id  Delete
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Delete Export Lineage Dbt V4 Export Lineage  Item Id  Delete
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Delete Export Lineage Dbt V4 Export Lineage  Item Id  Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - DBT_V4
      summary: Get Export Lineage By Id
      operationId: get_export_lineage_by_id_dbt_v4_export_lineage__item_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: item_id
        in: path
        required: true
        schema:
          type: integer
          title: Item Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportLineageResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Export Lineage By Id Dbt V4 Export Lineage  Item Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Export Lineage By Id Dbt V4 Export Lineage  Item Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    BulkDocsPropCreditRequest:
      properties:
        num_columns:
          type: integer
          title: Num Columns
        session_id:
          type: string
          title: Session Id
      type: object
      required:
      - num_columns
      - session_id
      title: BulkDocsPropCreditRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SelectedColumn:
      properties:
        model_node:
          anyOf:
          - $ref: '#/components/schemas/ModelNode'
          - type: 'null'
        column:
          type: string
          title: Column
      type: object
      required:
      - column
      title: SelectedColumn
    TableColumn:
      properties:
        name:
          type: string
          title: Name
        table:
          type: string
          title: Table
      type: object
      required:
      - name
      - table
      title: TableColumn
    DBTColumnLineageResponseV4:
      properties:
        column_lineage:
          items:
            $ref: '#/components/schemas/ColumnLineageLink'
          type: array
          title: Column Lineage
        confidence:
          anyOf:
          - $ref: '#/components/schemas/Confidence'
          - type: 'null'
        errors:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Errors
        errors_dict:
          anyOf:
          - additionalProperties:
              items:
                type: string
              type: array
            type: object
          - type: 'null'
          title: Errors Dict
      type: object
      required:
      - column_lineage
      title: DBTColumnLineageResponseV4
    DBTColumnLineageRequestV4:
      properties:
        model_dialect:
          type: string
          title: Model Dialect
        model_info:
          items:
            $ref: '#/components/schemas/ModelInfo'
          type: array
          title: Model Info
        targets:
          items:
            $ref: '#/components/schemas/ColumnIdentifier'
          type: array
          title: Targets
        upstream_expansion:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Upstream Expansion
        upstream_models:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Upstream Models
          default: []
        selected_column:
          anyOf:
          - $ref: '#/components/schemas/SelectedColumn'
          - type: 'null'
        session_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Session Id
        show_indirect_edges:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Show Indirect Edges
          default: false
        event_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Event Type
          default: column_lineage
      type: object
      required:
      - model_dialect
      - model_info
      - targets
      title: DBTColumnLineageRequestV4
    ModelNode:
      properties:
        database:
          anyOf:
          - type: string
          - type: 'null'
          title: Database
        schema_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Schema Name
        package_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Package Name
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        alias:
          type: string
          title: Alias
        uniqueId:
          type: string
          title: Uniqueid
        columns:
          additionalProperties:
            $ref: '#/components/schemas/ModelColumn'
          type: object
          title: Columns
      type: object
      required:
      - alias
      - uniqueId
      - columns
      title: ModelNode
    UserBasicResponse:
      properties:
        uuid:
          type: string
          format: uuid
          title: Uuid
        id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Id
        first_name:
          anyOf:
          - type: string
          - type: 'null'
          title: First Name
        last_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Name
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        is_active:
          type: boolean
          title: Is Active
        is_invited:
          type: boolean
          title: Is Invited
        is_onboarded:
          type: boolean
          title: Is Onboarded
        is_verified:
          type: boolean
          title: Is Verified
        deleted_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Deleted At
      type: object
      required:
      - uuid
      - is_active
      - is_invited
      - is_onboarded
      - is_verified
      title: UserBasicResponse
    ExportLineageResponse:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        lineage_data:
          additionalProperties: true
          type: object
          title: Lineage Data
        created_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created At
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
        created_by:
          anyOf:
          - type: integer
          - type: 'null'
          title: Created By
        last_modified_by:
          anyOf:
          - type: integer
          - type: 'null'
          title: Last Modified By
        user:
          anyOf:
          - $ref: '#/components/schemas/UserBasicResponse'
          - type: 'null'
      type: object
      required:
      - id
      - name
      - lineage_data
      title: ExportLineageResponse
      description: Response schema for export lineage (GET output)
    ColumnLineageLink:
      properties:
        source:
          $ref: '#/components/schemas/ColumnIdentifier'
        target:
          $ref: '#/components/schemas/ColumnIdentifier'
        type:
          type: string
          title: Type
        views_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Views Type
        views_code:
          items:
            prefixItems:
            - type: string
            - type: string
            type: array
            maxItems: 2
            minItems: 2
          type: array
          title: Views Code
      type: object
      required:
      - source
      - target
      - type
      - views_code
      title: ColumnLineageLink
    ExportLineageRequest:
      properties:
        name:
          type: string
          title: Name
        lineage_data:
          $ref: '#/components/schemas/ExportLineageData'
      type: object
      required:
      - name
      - lineage_data
      title: ExportLineageRequest
      description: Request schema for creating export lineage (POST input)
    ExportLineageData:
      properties:
        selectedColumn:
          anyOf:
          - $ref: '#/components/schemas/TableColumn'
          - type: 'null'
        collectColumns:
          additionalProperties: true
          type: object
          title: Collectcolumns
        tableEdges:
          items:
            prefixItems:
            - type: string
            - type: string
            type: array
            maxItems: 2
            minItems: 2
          type: array
          title: Tableedges
        columnEdges:
          items:
            prefixItems:
            - type: string
            - type: string
            - type: string
            type: array
            maxItems: 3
            minItems: 3
          type: array
          title: Columnedges
        details:
          additionalProperties: true
          type: object
          title: Details
      type: object
      required:
      - collectColumns
      - tableEdges
      - columnEdges
      - details
      title: ExportLineageData
    ModelInfo:
      properties:
        model_node:
          $ref: '#/components/schemas/ModelNode'
        compiled_sql:
          anyOf:
          - type: string
          - type: 'null'
          title: Compiled Sql
        raw_sql:
          anyOf:
          - type: string
          - type: 'null'
          title: Raw Sql
      type: object
      required:
      - model_node
      title: ModelInfo
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ColumnIdentifier:
      properties:
        uniqueId:
          type: string
          title: Uniqueid
        column_name:
          type: string
          title: Column Name
      type: object
      required:
      - uniqueId
      - column_name
      title: ColumnIdentifier
    StandardUrlResponse:
      properties:
        url:
          type: string
          title: Url
      type: object
      required:
      - url
      title: StandardUrlResponse
    Page_ExportLineageResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ExportLineageResponse'
          type: array
          title: Items
        total:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Total
        page:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Page
        size:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Size
        pages:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Pages
      type: object
      required:
      - items
      - total
      - page
      - size
      title: Page[ExportLineageResponse]
    StandardResponse:
      properties:
        ok:
          type: boolean
          title: Ok
      type: object
      required:
      - ok
      title: StandardResponse
    ModelColumn:
      properties:
        name:
          type: string
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        data_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Data Type
      type: object
      required:
      - name
      title: ModelColumn
    Confidence:
      properties:
        confidence:
          type: string
          title: Confidence
        operator_list:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Operator List
      type: object
      required:
      - confidence
      title: Confidence
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer