dialogbrain-com Workspace Database API

openapi: 3.2.0
info:
  title: DialogBrain v2 API Gateway Workspace Database API
  description: Clean refactored API gateway with minimal vertical slice
  version: 0.1.0
tags:
- name: workspace-database
paths:
  /api/workspace/database:
    get:
      tags:
      - workspace-database
      summary: Get Database
      description: Get connection info (no password).
      operationId: get_database_api_workspace_database_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    post:
      tags:
      - workspace-database
      summary: Create Database
      description: Create the workspace database (password returned ONCE).
      operationId: create_database_api_workspace_database_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    delete:
      tags:
      - workspace-database
      summary: Delete Database
      description: Drop database + role (irreversible).
      operationId: delete_database_api_workspace_database_delete
      responses:
        '204':
          description: Successful Response
  /api/workspace/database/tables:
    get:
      tags:
      - workspace-database
      summary: List Tables
      description: Table list with columns + row estimates.
      operationId: list_tables_api_workspace_database_tables_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/workspace/database/tables/{table_name}/preview:
    get:
      tags:
      - workspace-database
      summary: Preview Table Rows
      description: 'One page of a table for the table browser, with its primary key and

        whether its rows can be edited here.'
      operationId: preview_table_rows_api_workspace_database_tables__table_name__preview_get
      parameters:
      - name: table_name
        in: path
        required: true
        schema:
          type: string
          title: Table Name
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Offset
      - name: order_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Order By
      - name: descending
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Descending
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/workspace/database/tables/{table_name}/rows:
    post:
      tags:
      - workspace-database
      summary: Insert Table Row
      description: Add one row to a table of the workspace's own.
      operationId: insert_table_row_api_workspace_database_tables__table_name__rows_post
      parameters:
      - name: table_name
        in: path
        required: true
        schema:
          type: string
          title: Table Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RowInsert'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - workspace-database
      summary: Update Table Row
      description: Change one row, named by its primary key.
      operationId: update_table_row_api_workspace_database_tables__table_name__rows_patch
      parameters:
      - name: table_name
        in: path
        required: true
        schema:
          type: string
          title: Table Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RowUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/workspace/database/tables/{table_name}/rows/delete:
    post:
      tags:
      - workspace-database
      summary: Delete Table Row
      description: Delete one row, named by its primary key.
      operationId: delete_table_row_api_workspace_database_tables__table_name__rows_delete_post
      parameters:
      - name: table_name
        in: path
        required: true
        schema:
          type: string
          title: Table Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RowDelete'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/workspace/database/rotate:
    post:
      tags:
      - workspace-database
      summary: Rotate
      description: Rotate password (new password returned ONCE).
      operationId: rotate_api_workspace_database_rotate_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/workspace/database/query:
    post:
      tags:
      - workspace-database
      summary: Query
      description: Query console — NL question or raw SELECT (same path as db.query).
      operationId: query_api_workspace_database_query_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/src__api__workspace_databases__QueryRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/workspace/database/mirror:
    get:
      tags:
      - workspace-database
      summary: Mirror Status
      description: 'Mirror state: enabled, status, schema version, last sync, last error.'
      operationId: mirror_status_api_workspace_database_mirror_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    post:
      tags:
      - workspace-database
      summary: Enable Mirror
      description: 'Turn the mirror on: migrate the schemas, then snapshot into them.'
      operationId: enable_mirror_api_workspace_database_mirror_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    delete:
      tags:
      - workspace-database
      summary: Disable Mirror
      description: 'Turn it off: drops our schemas, leaves the customer''s `public` alone.'
      operationId: disable_mirror_api_workspace_database_mirror_delete
      responses:
        '204':
          description: Successful Response
  /api/workspace/database/mirror/resync:
    post:
      tags:
      - workspace-database
      summary: Resync Mirror
      description: 'Force a full mirror sync right now instead of waiting for the sweeps.


        Runs the same two passes the background worker does — reconcile (missed

        inserts/updates) and the deletion sweep (rows the platform hard-deleted

        that never got an erasure event) — so the customer sees their mirror

        match the platform immediately after a bulk operation.'
      operationId: resync_mirror_api_workspace_database_mirror_resync_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/workspace/database/outbox:
    post:
      tags:
      - workspace-database
      summary: Enable Outbox
      description: 'Turn the write path on. Opt-in even for a workspace that already mirrors:

        reading your data and acting from it are different decisions.'
      operationId: enable_outbox_api_workspace_database_outbox_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    delete:
      tags:
      - workspace-database
      summary: Disable Outbox
      description: 'Stop draining. The table stays: queued intents and their outcomes are a

        record of what the customer asked for, not ours to delete.'
      operationId: disable_outbox_api_workspace_database_outbox_delete
      responses:
        '204':
          description: Successful Response
  /api/workspace/database/vectors:
    get:
      tags:
      - workspace-database
      summary: Vector Info
      description: 'The Vectors card: collection, point counts (estimates), endpoint, key state.'
      operationId: vector_info_api_workspace_database_vectors_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/workspace/database/vectors/search:
    post:
      tags:
      - workspace-database
      summary: Vector Search
      description: 'Semantic search over the workspace''s text collection — the same

        embed-and-query pipeline the agents use (rag-orchestrator /search), so

        what the user sees here is exactly what their agent retrieves.'
      operationId: vector_search_api_workspace_database_vectors_search_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VectorSearchRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/workspace/database/vectors/key:
    post:
      tags:
      - workspace-database
      summary: Mint Vector Key
      description: 'Mint or rotate the collection-scoped read-only key. Returned ONCE.


        Rotation trade stated where the caller sees it: JWTs are stateless, so the

        old key stays valid until the INSTANCE key rotates (a fleet event).'
      operationId: mint_vector_key_api_workspace_database_vectors_key_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    src__api__workspace_databases__QueryRequest:
      properties:
        question:
          anyOf:
          - type: string
          - type: 'null'
          title: Question
        sql:
          anyOf:
          - type: string
          - type: 'null'
          title: Sql
      type: object
      title: QueryRequest
    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
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    RowInsert:
      properties:
        values:
          additionalProperties: true
          type: object
          title: Values
      type: object
      title: RowInsert
    VectorSearchRequest:
      properties:
        query:
          type: string
          maxLength: 1000
          minLength: 1
          title: Query
        limit:
          type: integer
          maximum: 20.0
          minimum: 1.0
          title: Limit
          default: 10
      type: object
      required:
      - query
      title: VectorSearchRequest
    RowUpdate:
      properties:
        key:
          additionalProperties: true
          type: object
          title: Key
        values:
          additionalProperties: true
          type: object
          title: Values
      type: object
      required:
      - key
      - values
      title: RowUpdate
    RowDelete:
      properties:
        key:
          additionalProperties: true
          type: object
          title: Key
      type: object
      required:
      - key
      title: RowDelete