Altimate AI DBT API
The DBT API from Altimate AI — 16 operation(s) for dbt.
The DBT API from Altimate AI — 16 operation(s) for dbt.
openapi: 3.1.0
info:
title: Fast ACCOUNT_COSTS DBT API
version: 0.1.0
tags:
- name: DBT
paths:
/dbt/v1/:
post:
tags:
- DBT
summary: Dbt Docs Gen
description: 'Generates Dbt docs for a dbt_model
:param db: The database session for accessing the database.
:param auth: The authorization token for the request.
:param dbt_model: DBTModel.
:return: DBTDocsGenResponse'
operationId: dbt_docs_gen_dbt_v1__post
deprecated: true
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/DBTDocsGenRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DBTDocsGenResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Dbt Docs Gen Dbt V1 Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Dbt Docs Gen Dbt V1 Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/lineage:
post:
tags:
- DBT
summary: Get Column Level Lineage
description: Generates lineage analysis for a dbt_model
operationId: get_column_level_lineage_dbt_v1_lineage_post
deprecated: true
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/DBTColumnLineageRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
type: object
additionalProperties: true
title: Response Get Column Level Lineage Dbt V1 Lineage Post
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Column Level Lineage Dbt V1 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 V1 Lineage Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/query-explain:
post:
tags:
- DBT
summary: Dbt Quick Explain Query
operationId: dbt_quick_explain_query_dbt_v1_query_explain_post
deprecated: true
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/DBTExplainQueryRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Dbt Quick Explain Query Dbt V1 Query Explain Post
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Dbt Quick Explain Query Dbt V1 Query Explain Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Dbt Quick Explain Query Dbt V1 Query Explain Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/sqltomodel:
post:
tags:
- DBT
summary: Get Model From Sql
operationId: get_model_from_sql_dbt_v1_sqltomodel_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/SQLToModelRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Model From Sql Dbt V1 Sqltomodel Post
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Model From Sql Dbt V1 Sqltomodel Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Model From Sql Dbt V1 Sqltomodel Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/signed_url:
get:
tags:
- DBT
summary: Get Secure Signed Url
operationId: get_secure_signed_url_dbt_v1_signed_url_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: dbt_core_integration_id
in: query
required: true
schema:
type: integer
title: Dbt Core Integration Id
- name: dbt_core_integration_environment_type
in: query
required: false
schema:
type: string
default: PROD
title: Dbt Core Integration Environment Type
- name: file_type
in: query
required: true
schema:
$ref: '#/components/schemas/DbtFileType'
- 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/SecureSignedURLResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Secure Signed Url Dbt V1 Signed Url Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Secure Signed Url Dbt V1 Signed Url Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/download_signed_url:
post:
tags:
- DBT
summary: Post Download Secure Signed Url
operationId: post_download_secure_signed_url_dbt_v1_download_signed_url_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/DownloadSignedUrlRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DownloadSignedUrlResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Post Download Secure Signed Url Dbt V1 Download Signed Url Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Post Download Secure Signed Url Dbt V1 Download Signed Url Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/verify_upload:
post:
tags:
- DBT
summary: Verify File Upload
operationId: verify_file_upload_dbt_v1_verify_upload_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/VerifyFileUploadRequest'
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 Verify File Upload Dbt V1 Verify Upload Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Verify File Upload Dbt V1 Verify Upload Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/fetch_artifact_url:
get:
tags:
- DBT
summary: Fetch Artifact Url
operationId: fetch_artifact_url_dbt_v1_fetch_artifact_url_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: dbt_core_integration_id
in: query
required: true
schema:
type: integer
title: Dbt Core Integration Id
- name: artifact_type
in: query
required: true
schema:
$ref: '#/components/schemas/DbtFileType'
- 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/SecureSignedURLResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Fetch Artifact Url Dbt V1 Fetch Artifact Url Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Fetch Artifact Url Dbt V1 Fetch Artifact Url Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/start_dbt_ingestion:
post:
tags:
- DBT
summary: Post Start Dbt Ingestion
operationId: post_start_dbt_ingestion_dbt_v1_start_dbt_ingestion_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/DBTStartIngestionRequest'
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 Start Dbt Ingestion Dbt V1 Start Dbt Ingestion Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Post Start Dbt Ingestion Dbt V1 Start Dbt Ingestion Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/project_integration:
post:
tags:
- DBT
summary: Create Project Integration
operationId: create_project_integration_dbt_v1_project_integration_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/ProjectIntegrationRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectIntegrationResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Create Project Integration Dbt V1 Project Integration Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Create Project Integration Dbt V1 Project Integration Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/project_integrations:
get:
tags:
- DBT
summary: Get Project Integrations
operationId: get_project_integrations_dbt_v1_project_integrations_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProjectIntegrationResponse'
title: Response Get Project Integrations Dbt V1 Project Integrations Get
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Project Integrations Dbt V1 Project Integrations Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Project Integrations Dbt V1 Project Integrations Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/validate-permissions:
get:
tags:
- DBT
summary: Validate Permissions
operationId: validate_permissions_dbt_v1_validate_permissions_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- 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/StandardResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Validate Permissions Dbt V1 Validate Permissions Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Validate Permissions Dbt V1 Validate Permissions Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/project_integrations/{integration_id}/{integration_env}:
get:
tags:
- DBT
summary: Get Project Integrations
operationId: get_project_integrations_dbt_v1_project_integrations__integration_id___integration_env__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: integration_id
in: path
required: true
schema:
type: integer
title: Integration Id
- name: integration_env
in: path
required: true
schema:
type: string
title: Integration Env
- 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/ProjectIntegrationDetailsResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Project Integrations Dbt V1 Project Integrations Integration Id Integration Env Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Project Integrations Dbt V1 Project Integrations Integration Id Integration Env Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/defer_to_prod_event:
post:
tags:
- DBT
summary: Defer To Prod Event
operationId: defer_to_prod_event_dbt_v1_defer_to_prod_event_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/DBTDeferToProdRequest'
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 Defer To Prod Event Dbt V1 Defer To Prod Event Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Defer To Prod Event Dbt V1 Defer To Prod Event Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/integration_environments/{dbt_core_integration_id}:
get:
tags:
- DBT
summary: Get Project Integration Environments
operationId: get_project_integration_environments_dbt_v1_integration_environments__dbt_core_integration_id__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: dbt_core_integration_id
in: path
required: true
schema:
type: integer
title: Dbt Core Integration Id
- name: x-tenant
in: header
required: true
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 Get Project Integration Environments Dbt V1 Integration Environments Dbt Core Integration Id Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Project Integration Environments Dbt V1 Integration Environments Dbt Core Integration Id Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/v1/project_integration/{integration_id}:
delete:
tags:
- DBT
summary: Delete Project Integration
operationId: delete_project_integration_dbt_v1_project_integration__integration_id__delete
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: integration_id
in: path
required: true
schema:
type: integer
title: Integration 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/StandardResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Delete Project Integration Dbt V1 Project Integration Integration Id Delete
'403':
description: Demo accounts cannot delete dbt integrations
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
SourceTable:
properties:
name:
type: string
title: Name
type: object
required:
- name
title: SourceTable
DownloadSignedUrlRequest:
properties:
s3_path:
type: string
title: S3 Path
type: object
required:
- s3_path
title: DownloadSignedUrlRequest
ProjectIntegrationRequest:
properties:
name:
type: string
title: Name
environment:
anyOf:
- type: string
- type: 'null'
title: Environment
integration_type:
anyOf:
- $ref: '#/components/schemas/app__schemas__dbt__IntegrationType'
- type: 'null'
default: dbt_core
type: object
required:
- name
title: ProjectIntegrationRequest
ColumnDescription:
properties:
column_name:
type: string
title: Column Name
column_description:
type: string
title: Column Description
column_citations:
anyOf:
- items:
$ref: '#/components/schemas/Citation'
type: array
- type: 'null'
title: Column Citations
type: object
required:
- column_name
- column_description
title: ColumnDescription
Citation:
properties:
id:
type: string
title: Id
content:
type: string
title: Content
taskLabel:
type: string
title: Tasklabel
type: object
required:
- id
- content
- taskLabel
title: Citation
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
DBTModel-Input:
properties:
model_name:
type: string
title: Model Name
adapter:
anyOf:
- type: string
- type: 'null'
title: Adapter
model_description:
anyOf:
- type: string
- type: 'null'
title: Model Description
compiled_sql:
anyOf:
- type: string
- type: 'null'
title: Compiled Sql
schedule:
anyOf:
- type: string
- type: 'null'
title: Schedule
columns:
anyOf:
- items:
$ref: '#/components/schemas/Column'
type: array
- type: 'null'
title: Columns
dependencies:
anyOf:
- items:
$ref: '#/components/schemas/DBTModel-Input'
type: array
- type: 'null'
title: Dependencies
type: object
required:
- model_name
title: DBTModel
CreateProjectIntegrationResponse:
properties:
dbt_core_integration_id:
type: integer
title: Dbt Core Integration Id
integration_type:
anyOf:
- $ref: '#/components/schemas/app__schemas__dbt__IntegrationType'
- type: 'null'
default: dbt_core
type: object
required:
- dbt_core_integration_id
title: CreateProjectIntegrationResponse
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
Column:
properties:
column_name:
anyOf:
- type: string
- type: 'null'
title: Column Name
data_type:
anyOf:
- type: string
- type: 'null'
title: Data Type
description:
anyOf:
- type: string
- type: 'null'
title: Description
tests:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Tests
type: object
title: Column
DBTDeferToProdRequest:
properties:
defer_type:
$ref: '#/components/schemas/DBTDeferType'
type: object
required:
- defer_type
title: DBTDeferToProdRequest
SourceMetaData:
properties:
uniqueId:
type: string
title: Uniqueid
database:
type: string
title: Database
name:
type: string
title: Name
schema_name:
type: string
title: Schema Name
tables:
items:
$ref: '#/components/schemas/SourceTable'
type: array
title: Tables
type: object
required:
- uniqueId
- database
- name
- schema_name
- tables
title: SourceMetaData
VerifyFileUploadRequest:
properties:
dbt_core_integration_file_id:
type: integer
title: Dbt Core Integration File Id
type: object
required:
- dbt_core_integration_file_id
title: VerifyFileUploadRequest
DBTDeferType:
type: string
enum:
- local
- remote
title: DBTDeferType
DownloadSignedUrlResponse:
properties:
url:
type: string
title: Url
type: object
required:
- url
title: DownloadSignedUrlResponse
DBTDocsGenRequest:
properties:
columns:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Columns
dbt_model:
$ref: '#/components/schemas/DBTModel-Input'
gen_model_description:
anyOf:
- type: boolean
- type: 'null'
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/altimate-ai/refs/heads/main/openapi/altimate-ai-dbt-api-openapi.yml