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

# Add BI Column

> Adds one or more columns to the specified [Peaka BI Table](https://docs.peaka.com/connecting-your-data/peaka-bi-table). Each column definition includes its name, data type, display name, optional default value, and constraints (nullability, uniqueness). Peaka BI Table supports VARCHAR, BIGINT, BOOLEAN, TIMESTAMP, TIME, DATE, UUID, and DECIMAL data types. Note that JSON data type is not supported in Peaka BI Table.

<span style={{display: "flex", gap: "10px", flexDirection: "row", alignItems: "center"}}>
  <img src="https://cdn.peaka.com/badges/partner-api-key-badge.png" />

  <img src="https://cdn.peaka.com/badges/project-api-key-badge.png" />
</span>


## OpenAPI

````yaml post /data/projects/{projectId}/bitable/{tableName}/columns
openapi: 3.0.1
info:
  title: Peaka Gateway API
  description: Peaka Gateway API Documentation
  version: '1.0'
servers:
  - url: https://partner.peaka.studio/api/v1
    description: Default Server URL (US Zone)
  - url: https://partner.eu.peaka.studio/api/v1
    description: EU Zone
security:
  - bearerAuth: []
paths:
  /data/projects/{projectId}/bitable/{tableName}/columns:
    post:
      tags:
        - Data -- Internal Tables
      summary: Add BI Column
      description: >-
        Adds one or more columns to the specified [Peaka BI
        Table](https://docs.peaka.com/connecting-your-data/peaka-bi-table). Each
        column definition includes its name, data type, display name, optional
        default value, and constraints (nullability, uniqueness). Peaka BI Table
        supports VARCHAR, BIGINT, BOOLEAN, TIMESTAMP, TIME, DATE, UUID, and
        DECIMAL data types. Note that JSON data type is not supported in Peaka
        BI Table.
      operationId: addBiColumn
      parameters:
        - name: projectId
          in: path
          description: ID of the Project
          required: true
          schema:
            type: string
          example: mtKDhe1U
        - name: tableName
          in: path
          description: Name of the BI table
          required: true
          schema:
            type: string
          example: events
      requestBody:
        description: Column Request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ColumnRequest'
            examples:
              Add Column:
                description: Add Column
                value:
                  - name: varcharcol
                    dataType: VARCHAR
                    displayName: varcharcol
                    defaultValue: null
                    isNotNull: false
                    isUnique: false
                  - name: bigintcol
                    dataType: BIGINT
                    displayName: bigintcol
                    defaultValue: null
                    isNotNull: false
                    isUnique: false
                  - name: booleancol
                    dataType: BOOLEAN
                    displayName: booleancol
                    defaultValue: null
                    isNotNull: false
                    isUnique: false
                  - name: timestampcol
                    dataType: TIMESTAMP
                    displayName: timestampcol
                    defaultValue: null
                    isNotNull: false
                    isUnique: false
                  - name: timecol
                    dataType: TIME
                    displayName: timecol
                    defaultValue: null
                    isNotNull: false
                    isUnique: false
                  - name: datecol
                    dataType: DATE
                    displayName: datecol
                    defaultValue: null
                    isNotNull: false
                    isUnique: false
                  - name: uuidcol
                    dataType: UUID
                    displayName: uuidcol
                    defaultValue: null
                    isNotNull: false
                    isUnique: false
                  - name: decimalcol
                    dataType: DECIMAL
                    displayName: decimalcol
                    defaultValue: null
                    isNotNull: false
                    isUnique: false
        required: true
      responses:
        '200':
          description: Column added successfully
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ColumnDetail'
              example:
                - name: num19
                  dataType: bigint
                  displayName: num19
                  defaultValue: null
                  isNotNull: false
                  isUnique: false
                - name: num18
                  dataType: bigint
                  displayName: num18
                  defaultValue: '3'
                  isNotNull: false
                  isUnique: true
components:
  schemas:
    ColumnRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the column.
        dataType:
          type: string
          description: The data type of the column.
          enum:
            - VARCHAR
            - BIGINT
            - BOOLEAN
            - DECIMAL
            - TIMESTAMP
            - TIME
            - DATE
            - UUID
        displayName:
          type: string
          description: The display name of the column.
        defaultValue:
          type: string
          description: The default value of the column.
        isNotNull:
          type: boolean
          description: The not null flag for the column.
        isUnique:
          type: boolean
          description: The unique flag for the column.
      description: |-
        ColumnRequest is used to create, update, display a column in a table.
         It contains the name, data type, display name, default value, not null and unique status of the column request.
    ColumnDetail:
      type: object
      properties:
        id:
          type: string
          description: The id of the column.
        name:
          type: string
          description: The name of the column.
        dataType:
          type: string
          description: The data type of the column.
        displayName:
          type: string
          description: The display name of the column.
        defaultValue:
          type: string
          description: The default value of the column.
        isNotNull:
          type: boolean
          description: The not null flag for the column.
        isUnique:
          type: boolean
          description: The unique flag for the column.
        desc:
          type: string
          description: The description of the column.
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        Use the Authorization header with the value 'Bearer <apiKey>' to
        authenticate. Partner API Keys have full access; Project API Keys are
        limited to their project scope. Learn more:
        https://docs.peaka.com/api-reference/authentication
      scheme: bearer
      bearerFormat: Api Key

````