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

# Add an input column to a query

> <Note>
  This endpoint requires edit access to the specified document and permissions to edit the document's model. The connection the document is built on must have a configured [table upload schema](/connect-data/setup).
</Note>

Add an [input column](/analyze-explore/input-columns) to a query on a draft. Not supported for SQL, blank, linked, or foreign query tabs.




## OpenAPI

````yaml /api/openapi.yaml post /v2/documents/{documentId}/draft/{draftId}/queries/{queryKey}/input-columns
openapi: 3.1.0
info:
  title: Omni API
  description: >
    The Omni REST API provides programmatic access to your Omni instance for
    managing users, documents, queries, schedules, and more.  
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
  - url: https://{instance}.omniapp.co/api
    description: Production
    variables:
      instance:
        default: blobsrus
        description: Your production Omni instance subdomain
  - url: https://{instance}.playground.exploreomni.dev/api
    description: Playground
    variables:
      instance:
        default: blobsrus
        description: Your playground Omni instance subdomain
security:
  - bearerAuth: []
  - orgApiKey: []
tags:
  - name: Who Am I
    description: Inspect your own user permissions
  - name: AI
    description: AI-powered query generation
  - name: AI Credit Controls
    description: Manage organization-level AI credit usage
  - name: AI Credit Usage
    description: Monitor AI credit usage
  - name: AI Evals
    description: >-
      Manage prompt sets and runs used to score AI quality against curated
      prompt suites.
  - name: AI Model Suggestions
    description: Manage AI-generated suggestions for shared models
  - name: AI Routines
    description: >-
      Manage Routines, which are scheduled, recurring AI-powered tasks that run
      automatically on your data
  - name: Apps
    description: Draft and publish app documents.
  - name: App downloads
    description: Download apps as PNG, PDF, XLSX, or CSV files
  - name: Branches
    description: List branches and open or close them to Viewers and Restricted Queriers
  - name: Documents v2
    description: >
      A draft-based workflow for creating and editing documents: create a
      document, patch a draft, then publish.
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: IP Allowlist
    description: Manage the organization's IP allowlist
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - name: Color Palettes
    description: Manage custom chart color palettes
  - name: Content
    description: Unified content retrieval (documents and folders)
  - name: Content migration
    description: Export and import dashboards
  - name: Content validator
    description: Validate content against models and perform find/replace operations
  - name: Dashboard downloads
    description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
  - name: Dashboard filters and controls
    description: Read and update dashboard filter and control default values
  - name: dbt
    description: Manage dbt configuration for connections
  - name: Document favorites
    description: Favorite and unfavorite documents
  - name: Document labels
    description: Apply and manage labels on documents
  - name: Document permissions
    description: Manage document-level access
  - name: Embed
    description: Manage embed sessions
  - name: Labels
    description: |
      Manage labels in the organization
  - name: Folders
    description: Create and organize content folders
  - name: Folder favorites
    description: Favorite and unfavorite folders
  - name: Folder labels
    description: Apply and manage labels on folders
  - name: Folder permissions
    description: Manage folder-level access
  - name: Jobs
    description: Check status of asynchronous jobs
  - name: Models
    description: Create and manage data models
  - name: Model branches
    description: Manage model branches and merge changes
  - name: Model git configuration
    description: Manage git configuration for shared models
  - name: Queries
    description: Execute workbook queries
  - name: Schedules
    description: Create and manage scheduled tasks
  - name: Schedule recipients
    description: Manage schedule recipients
  - name: Schema refresh schedules
    description: Manage automated schema refresh schedules for connections
  - name: Skills
    description: >-
      Manage skills, the saved slash-command instructions the Omni AI assistant
      runs
  - name: Topics
    description: Retrieve topic information from models
  - name: Uploads
    description: Manage file uploads
  - name: Users
    description: Manage users
  - name: User attributes
    description: Manage user attribute definitions
  - name: User groups
    description: Manage user groups
  - name: User model roles
    description: Manage model and connection role assignments for users
  - name: User group model roles
    description: Manage model and connection role assignments for user groups
  - name: Uploads
    description: Manage CSV and spreadsheet uploads
paths:
  /v2/documents/{documentId}/draft/{draftId}/queries/{queryKey}/input-columns:
    post:
      tags:
        - Documents v2
      summary: Add an input column to a query
      description: >
        <Note>
          This endpoint requires edit access to the specified document and permissions to edit the document's model. The connection the document is built on must have a configured [table upload schema](/connect-data/setup).
        </Note>


        Add an [input column](/analyze-explore/input-columns) to a query on a
        draft. Not supported for SQL, blank, linked, or foreign query tabs.
      operationId: documentsCreateInputColumn
      parameters:
        - name: documentId
          in: path
          required: true
          schema:
            type: string
            example: abc123
          description: Published document identifier.
        - name: draftId
          in: path
          required: true
          schema:
            type: string
            example: def456
          description: The draft workbook identifier to add the input column to.
        - name: queryKey
          in: path
          required: true
          schema:
            type: string
            pattern: ^[1-9][0-9]*$
            example: '1'
          description: Record key of the query, as it appears in `queryPresentations.data`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                columnName:
                  type: string
                  minLength: 1
                  maxLength: 60
                  pattern: '[a-zA-Z0-9]'
                  description: >
                    The column's name. Lowercase letters, digits, and
                    underscores; anything else is converted. Its values live in
                    the view `input_<columnName>`.
                  example: review_status
                dataType:
                  type: string
                  enum:
                    - text
                    - number
                    - boolean
                  description: The type of value each cell holds.
                editMode:
                  type: string
                  enum:
                    - draft
                    - published
                  description: >
                    How values can be edited once the document is published.


                    - `draft` - Column values can only be edited when in a draft

                    - `published` - Column values can only be edited when
                    viewing the published document.


                    Defaults to `published` on an app draft, `draft` otherwise.
                keyColumnFieldNames:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  description: >
                    Fully-qualified field names that identify a row, taken from
                    the query.


                    The fully-qualified names (`view.field`) of fields that
                    uniquely identify a row, taken from the query. If set, every
                    row must have a value for each key column.


                    Omit to use the primary key of the views used in the query.
                    Access filters on the query's topic are always added, if
                    applicable.
                  example:
                    - orders.id
                auditMetadata:
                  type: boolean
                  default: false
                  description: >
                    Whether to track who last edited each value and when, in two
                    extra columns written to the warehouse.
              required:
                - columnName
                - dataType
            examples:
              reviewStatus:
                summary: Add a text input column keyed on orders.id
                value:
                  columnName: review_status
                  dataType: text
                  keyColumnFieldNames:
                    - orders.id
                  editMode: published
      responses:
        '201':
          description: >-
            The column was created and added to the tile's query. The response
            names the field the tile and an app use for it.
          content:
            application/json:
              schema:
                type: object
                properties:
                  columnName:
                    type: string
                    description: The column's name as stored.
                    example: review_status
                  dataType:
                    type: string
                    enum:
                      - text
                      - number
                      - boolean
                  draftIdentifier:
                    type: string
                    description: Identifier of the draft the column was added to.
                  editMode:
                    type: string
                    enum:
                      - draft
                      - published
                  fieldName:
                    type: string
                    description: >
                      The fully-qualified field of the column in the query,
                      `input_<columnName>.<columnName>`.
                    example: input_review_status.review_status
                  identifier:
                    type: string
                    description: Published document identifier.
                  keyColumnFieldNames:
                    type: array
                    items:
                      type: string
                    description: >-
                      The fully-qualified fields the values are keyed on,
                      including any access filter the server added.
                    example:
                      - orders.id
                  viewName:
                    type: string
                    description: The view the column's values live in.
                    example: input_review_status
                required:
                  - columnName
                  - dataType
                  - draftIdentifier
                  - editMode
                  - fieldName
                  - identifier
                  - keyColumnFieldNames
                  - viewName
              example:
                columnName: review_status
                dataType: text
                draftIdentifier: def456
                editMode: published
                fieldName: input_review_status.review_status
                identifier: abc123
                keyColumnFieldNames:
                  - orders.id
                viewName: input_review_status
        '400':
          description: |
            Possible causes:

            - Invalid body or `queryKey`
            - The query is not a field-based query with fields selected
            - The key columns are not fields in the query
            - The column was refused by name
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError400'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError401'
        '403':
          description: >-
            Insufficient permissions: no edit access to the document, or no
            upload or modeling rights on its model.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError403'
        '404':
          description: Document, draft, or tile not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError404'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '409':
          description: |
            Possible causes:

            - The connection has no upload schema; nothing was created
            - The column name could not be checked; nothing was created
            - The column was created but could not be added to the query
            - The query changed — the detail names the field to add to the query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError409'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    ApiError400:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 400
      required:
        - detail
        - status
    ApiError401:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
          example: 'Unauthorized: Missing or invalid API key'
        status:
          type: integer
          description: HTTP status code of the error.
          example: 401
      required:
        - detail
        - status
    ApiError403:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 403
      required:
        - detail
        - status
    ApiError404:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 404
      required:
        - detail
        - status
    ApiError409:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 409
      required:
        - detail
        - status
    Error:
      type: object
      properties:
        error:
          type: string
          description: HTTP response code for the error
          example: <response_code>
        message:
          type: string
          description: Detailed error description
          example: <error_reason>
  responses:
    MethodNotAllowed:
      description: Method Not Allowed - Invalid HTTP method for this endpoint
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Can be either an [Organization API
        Key](/api/authentication#organization-api-keys) or [Personal Access
        Token (PAT)](/api/authentication#token-types).


        Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
    orgApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Requires an [Organization API
        Key](/api/authentication#organization-api-keys). Personal Access Tokens
        (PATs) are not supported for this endpoint.


        Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`

````