> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heyhumm.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate Database Schema Descriptions

> Generate AI-powered descriptions for all schemas in a database.

Analyzes schema metadata, table descriptions, and relationships to generate concise,
agent-optimized descriptions for schemas that don't have them
(or all schemas if overwrite_existing is True).

Optionally generates missing table/column descriptions first (cascade_tables=True).



## OpenAPI

````yaml https://config.heyhumm.ai/api/openapi.json post /api/integration-sources/{source_id}/databases/{database_id}/generate-schema-descriptions
openapi: 3.1.0
info:
  title: Configuration API
  description: >-
    API for managing configuration and queues for various services. This service
    consolidates the API functionality previously provided by dd_rag_api and
    code_rag_api.
  version: 1.0.0
servers:
  - url: https://config.heyhumm.ai
security: []
paths:
  /api/integration-sources/{source_id}/databases/{database_id}/generate-schema-descriptions:
    post:
      tags:
        - Integration Sources
      summary: Generate Database Schema Descriptions
      description: >-
        Generate AI-powered descriptions for all schemas in a database.


        Analyzes schema metadata, table descriptions, and relationships to
        generate concise,

        agent-optimized descriptions for schemas that don't have them

        (or all schemas if overwrite_existing is True).


        Optionally generates missing table/column descriptions first
        (cascade_tables=True).
      operationId: >-
        generate_database_schema_descriptions_api_integration_sources__source_id__databases__database_id__generate_schema_descriptions_post
      parameters:
        - name: source_id
          in: path
          required: true
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Source Id
        - name: database_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Database Id
        - name: organization_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Organization Id
        - name: resource_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Resource Id
        - name: integration_source_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Integration Source Id
        - name: data_source_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Data Source Id
        - name: context_source_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Context Source Id
        - name: job_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Job Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateDatabaseSchemaDescriptionsRequest'
              default:
                overwrite_existing: false
                cascade_tables: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
        - HTTPBearer: []
components:
  schemas:
    GenerateDatabaseSchemaDescriptionsRequest:
      properties:
        overwrite_existing:
          type: boolean
          title: Overwrite Existing
          description: Regenerate descriptions for schemas that already have them
          default: false
        cascade_tables:
          type: boolean
          title: Cascade Tables
          description: Generate missing table/column descriptions first
          default: true
      type: object
      title: GenerateDatabaseSchemaDescriptionsRequest
      description: Request for bulk database schema description generation.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````