Altimate AI DBT_DOCS_SHARE API
The DBT_DOCS_SHARE API from Altimate AI — 11 operation(s) for dbt_docs_share.
The DBT_DOCS_SHARE API from Altimate AI — 11 operation(s) for dbt_docs_share.
openapi: 3.1.0
info:
title: Fast ACCOUNT_COSTS DBT_DOCS_SHARE API
version: 0.1.0
tags:
- name: DBT_DOCS_SHARE
paths:
/dbt/dbt_docs_share/:
post:
tags:
- DBT_DOCS_SHARE
summary: Share Docs
description: Create a shareable link for the given docs
operationId: share_docs_dbt_dbt_docs_share__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/DBTDocsShareRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DBTDocsShareResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Share Docs Dbt Dbt Docs Share Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Share Docs Dbt Dbt Docs Share Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- DBT_DOCS_SHARE
summary: Share Docs
description: Create a shareable link for the given docs
operationId: share_docs_dbt_dbt_docs_share__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: names
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Names
- name: owners
in: query
required: false
schema:
anyOf:
- type: array
items:
type: integer
- type: 'null'
title: Owners
- name: sort_key
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
default: created_at
title: Sort Key
- name: sort_order
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
default: desc
title: Sort Order
- 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_DBTDocsShareGetAllResponse_'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Share Docs Dbt Dbt Docs Share Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Share Docs Dbt Dbt Docs Share Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/dbt_docs_share/all:
get:
tags:
- DBT_DOCS_SHARE
summary: Get All Share Docs
description: Get all shareable links for the given docs
operationId: get_all_share_docs_dbt_dbt_docs_share_all_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: projects
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
default: []
title: Projects
- 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/DBTDocsShareGetAllResponse'
title: Response Get All Share Docs Dbt Dbt Docs Share All Get
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get All Share Docs Dbt Dbt Docs Share All Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get All Share Docs Dbt Dbt Docs Share All Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/dbt_docs_share/{share_id}:
delete:
tags:
- DBT_DOCS_SHARE
summary: Delete Share
description: Delete a the dbt share for the given docs
operationId: delete_share_dbt_dbt_docs_share__share_id__delete
deprecated: true
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: share_id
in: path
required: true
schema:
type: integer
title: Share 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 Share Dbt Dbt Docs Share Share Id Delete
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Delete Share Dbt Dbt Docs Share Share Id Delete
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- DBT_DOCS_SHARE
summary: Get Docs Share
description: Get the shareable link for the given docs
operationId: get_docs_share_dbt_dbt_docs_share__share_id__get
security:
- HTTPBearer: []
parameters:
- name: share_id
in: path
required: true
schema:
type: integer
title: Share 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/DBTDocsShareGetResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Docs Share Dbt Dbt Docs Share Share Id Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Docs Share Dbt Dbt Docs Share Share Id Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/dbt_docs_share/filters:
get:
tags:
- DBT_DOCS_SHARE
summary: Share Doc Filters
description: Get filters for share docs
operationId: share_doc_filters_dbt_dbt_docs_share_filters_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/DBTDocsShareFiltersResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Share Doc Filters Dbt Dbt Docs Share Filters Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Share Doc Filters Dbt Dbt Docs Share Filters Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/dbt_docs_share/verify_upload/:
post:
tags:
- DBT_DOCS_SHARE
summary: Verify File Upload
operationId: verify_file_upload_dbt_dbt_docs_share_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/DBTDocsShareVerifyUploadRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DBTDocsShareVerifyUploadResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Verify File Upload Dbt Dbt Docs Share 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 Dbt Docs Share Verify Upload Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/dbt_docs_share/{project_name}:
get:
tags:
- DBT_DOCS_SHARE
summary: Get Docs Share By Project
description: Get the shareable link for the given docs
operationId: get_docs_share_by_project_dbt_dbt_docs_share__project_name__get
deprecated: true
security:
- HTTPBearer: []
parameters:
- name: project_name
in: path
required: true
schema:
type: string
title: Project Name
- 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/DBTDocsShareGetResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get Docs Share By Project Dbt Dbt Docs Share Project Name Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get Docs Share By Project Dbt Dbt Docs Share Project Name Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/dbt_docs_share/{share_id}/conversation_group:
post:
tags:
- DBT_DOCS_SHARE
summary: Create Conversation Group
description: Create a conversation group
operationId: create_conversation_group_dbt_dbt_docs_share__share_id__conversation_group_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: share_id
in: path
required: true
schema:
type: integer
title: Share Id
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DBTDocsConversationGroupRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ConversationGroupResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Create Conversation Group Dbt Dbt Docs Share Share Id Conversation Group Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Create Conversation Group Dbt Dbt Docs Share Share Id Conversation Group Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/dbt_docs_share/{share_id}/conversation_group/{conversation_group_id}/resolve:
post:
tags:
- DBT_DOCS_SHARE
summary: Resolve Conversation
description: Create a conversation group
operationId: resolve_conversation_dbt_dbt_docs_share__share_id__conversation_group__conversation_group_id__resolve_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: share_id
in: path
required: true
schema:
type: integer
title: Share Id
- name: conversation_group_id
in: path
required: true
schema:
type: integer
title: Conversation Group Id
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DBTDocsConversationGroupResolveRequest'
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 Resolve Conversation Dbt Dbt Docs Share Share Id Conversation Group Conversation Group Id Resolve Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Resolve Conversation Dbt Dbt Docs Share Share Id Conversation Group Conversation Group Id Resolve Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/dbt_docs_share/{share_id}/conversation_group/{conversation_group_id}/conversation:
post:
tags:
- DBT_DOCS_SHARE
summary: Post Conversation
description: Create a conversation group
operationId: post_conversation_dbt_dbt_docs_share__share_id__conversation_group__conversation_group_id__conversation_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: share_id
in: path
required: true
schema:
type: integer
title: Share Id
- name: conversation_group_id
in: path
required: true
schema:
type: integer
title: Conversation Group Id
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DBTDocsConversationRequest'
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 Conversation Dbt Dbt Docs Share Share Id Conversation Group Conversation Group Id Conversation Post
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Post Conversation Dbt Dbt Docs Share Share Id Conversation Group Conversation Group Id Conversation Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/dbt_docs_share/{share_id}/conversations:
get:
tags:
- DBT_DOCS_SHARE
summary: Get All Conversations
description: Get all conversations for a share
operationId: get_all_conversations_dbt_dbt_docs_share__share_id__conversations_get
security:
- HTTPBearer: []
parameters:
- name: share_id
in: path
required: true
schema:
type: integer
title: Share 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/DBTDocsConversationResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get All Conversations Dbt Dbt Docs Share Share Id Conversations Get
'403':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get All Conversations Dbt Dbt Docs Share Share Id Conversations Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/dbt/dbt_docs_share/user/details:
get:
tags:
- DBT_DOCS_SHARE
summary: Get User Auth Details
operationId: get_user_auth_details_dbt_dbt_docs_share_user_details_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/UserIndexResponse'
'400':
description: Not supported for public user
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 400 Get User Auth Details Dbt Dbt Docs Share User Details Get
'403':
description: Operation not allowed
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 403 Get User Auth Details Dbt Dbt Docs Share User Details Get
'404':
description: User not found
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response 404 Get User Auth Details Dbt Dbt Docs Share User Details Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
DBTDocsConversationGroupResolveRequest:
properties:
resolved:
type: boolean
title: Resolved
type: object
required:
- resolved
title: DBTDocsConversationGroupResolveRequest
DBTDocsConversationGroupRequest:
properties:
message:
type: string
title: Message
meta:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Meta
type: object
required:
- message
title: DBTDocsConversationGroupRequest
ConversationGroupResponse:
properties:
conversation_group_id:
type: integer
title: Conversation Group Id
conversation_id:
anyOf:
- type: integer
- type: 'null'
title: Conversation Id
type: object
required:
- conversation_group_id
title: ConversationGroupResponse
DBTDocsShareFiltersResponse:
properties:
names:
items:
type: string
type: array
title: Names
owners:
items:
$ref: '#/components/schemas/UserIndexResponse'
type: array
title: Owners
type: object
required:
- names
- owners
title: DBTDocsShareFiltersResponse
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ConversationModel:
properties:
conversation_id:
type: integer
title: Conversation Id
uuid:
type: string
title: Uuid
user_id:
type: integer
title: User Id
message:
type: string
title: Message
timestamp:
type: string
title: Timestamp
type: object
required:
- conversation_id
- uuid
- user_id
- message
- timestamp
title: ConversationModel
DBTDocsConversationRequest:
properties:
message:
type: string
title: Message
type: object
required:
- message
title: DBTDocsConversationRequest
DBTDocsShareGetResponse:
properties:
name:
type: string
title: Name
manifest_presigned_url:
type: string
title: Manifest Presigned Url
catalog_presigned_url:
type: string
title: Catalog Presigned Url
app_url:
type: string
title: App Url
type: object
required:
- name
- manifest_presigned_url
- catalog_presigned_url
- app_url
title: DBTDocsShareGetResponse
UserIndexResponse:
properties:
id:
type: integer
title: Id
uuid:
type: string
format: uuid
title: Uuid
first_name:
anyOf:
- type: string
- type: 'null'
title: First Name
last_name:
anyOf:
- type: string
- type: 'null'
title: Last Name
email:
type: string
title: Email
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
is_active:
type: boolean
title: Is Active
is_verified:
type: boolean
title: Is Verified
is_invited:
type: boolean
title: Is Invited
is_onboarded:
type: boolean
title: Is Onboarded
created_at:
anyOf:
- type: string
- type: 'null'
title: Created At
role_title:
anyOf:
- type: string
- type: 'null'
title: Role Title
display_name:
anyOf:
- type: string
- type: 'null'
title: Display Name
attributes:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Attributes
deleted_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Deleted At
last_login_at:
anyOf:
- type: string
- type: 'null'
title: Last Login At
role_source:
anyOf:
- type: string
- type: 'null'
title: Role Source
has_role_conflict:
type: boolean
title: Has Role Conflict
default: false
sso_resolved_role_id:
anyOf:
- type: integer
- type: 'null'
title: Sso Resolved Role Id
sso_resolved_role_title:
anyOf:
- type: string
- type: 'null'
title: Sso Resolved Role Title
type: object
required:
- id
- uuid
- email
- is_active
- is_verified
- is_invited
- is_onboarded
- created_at
title: UserIndexResponse
Page_DBTDocsShareGetAllResponse_:
properties:
items:
items:
$ref: '#/components/schemas/DBTDocsShareGetAllResponse'
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[DBTDocsShareGetAllResponse]
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
DBTDocsShareVerifyUploadResponse:
properties:
dbt_docs_share_url:
type: string
title: Dbt Docs Share Url
type: object
required:
- dbt_docs_share_url
title: DBTDocsShareVerifyUploadResponse
DBTDocsShareRequest:
properties:
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
project_name:
type: string
title: Project Name
type: object
required:
- name
- project_name
title: DBTDocsShareRequest
DBTDocsConversationResponse:
properties:
dbt_docs_share_conversations:
items:
$ref: '#/components/schemas/ConversationGroupModel'
type: array
title: Dbt Docs Share Conversations
type: object
required:
- dbt_docs_share_conversations
title: DBTDocsConversationResponse
StandardResponse:
properties:
ok:
type: boolean
title: Ok
type: object
required:
- ok
title: StandardResponse
DBTDocsShareResponse:
properties:
share_id:
type: integer
title: Share Id
manifest_presigned_url:
type: string
title: Manifest Presigned Url
catalog_presigned_url:
type: string
title: Catalog Presigned Url
type: object
required:
- share_id
- manifest_presigned_url
- catalog_presigned_url
title: DBTDocsShareResponse
DBTDocsShareGetAllResponse:
properties:
share_id:
type: integer
title: Share Id
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
expires_at:
anyOf:
- type: string
- type: 'null'
title: Expires At
created_at:
type: string
title: Created At
updated_at:
type: string
title: Updated At
owner:
type: integer
title: Owner
open_conversations:
type: integer
title: Open Conversations
default: 0
resolved_conversations:
type: integer
title: Resolved Conversations
default: 0
user:
$ref: '#/components/schemas/UserIndexResponse'
project_name:
type: string
title: Project Name
project_metadata:
additionalProperties: true
type: object
title: Project Metadata
conversation_group:
anyOf:
- items: {}
type: array
- type: 'null'
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/altimate-ai/refs/heads/main/openapi/altimate-ai-dbt-docs-share-api-openapi.yml