> ## 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.

# Create label

> Create a new label in the organization.

Any user can create basic labels, but **Organization Admin** permissions are required to:

- Create **Verified** labels (`verified: true`)
- Create **Homepage** labels (`homepage: true`)




## OpenAPI

````yaml /api/openapi.yaml post /v1/labels
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: AI
    description: AI-powered query generation
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - 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: Documents
    description: Create, retrieve, and manage documents
  - 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: Labels
    description: >
      Manage labels in an organization. Labels can be applied to documents and
      folders to help organize and categorize content.


      **Label types:**

      - **Basic labels**: Can be created and managed by any user

      - **Verified labels**: Indicate curated or officially sanctioned content.
      Admin-only.

      - **Homepage labels**: Appear on the organization homepage. Admin-only.
  - name: Folders
    description: Create and organize content 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: 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:
  /v1/labels:
    post:
      tags:
        - Labels
      summary: Create label
      description: >
        Create a new label in the organization.


        Any user can create basic labels, but **Organization Admin** permissions
        are required to:


        - Create **Verified** labels (`verified: true`)

        - Create **Homepage** labels (`homepage: true`)
      operationId: createLabel
      parameters:
        - name: userId
          in: query
          required: false
          schema:
            type: string
          description: >
            **Requires an Organization API key**. Optional user ID that
            attributes the action to the specified user.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: >
                    Label name. Must be 2-25 characters.


                    Names are case-insensitive: `"Production"` and
                    `"production"` are considered the same.
                color:
                  type: string
                  maxLength: 9
                  default: null
                  description: |
                    Hex color for the label
                  example: '#0366d6'
                description:
                  type: string
                  maxLength: 500
                  default: null
                  description: Description of the label
                  example: Documents based on dev schemas
                verified:
                  type: boolean
                  default: false
                  description: >
                    **Requires Organization Admin permissions**. If `true`,
                    documents with this label will be marked as
                    verified/curated.
                homepage:
                  type: boolean
                  default: false
                  description: >
                    **Requires Organization Admin permissions**. If `true`,
                    documents with this label will display on the instance's
                    Homepage.
            example:
              name: Dev
              color: '#0366d6'
              description: Documents based on dev schemas
      responses:
        '201':
          description: Label created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Label'
              example:
                name: Dev
                verified: true
                homepage: true
                usage_count: 0
                color: '#0366d6'
                description: Documents based on dev schemas
        '400':
          description: |
            Bad Request. Possible causes:

            - Label name too short (less than 2 characters)
            - Label name too long (more than 25 characters)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >
            Forbidden. Possible causes:


            - User lacks **Organization Admin** permissions, which are required
            to create Verified and Homepage labels

            - User lacks the permissions required to manage labels
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: |
            Conflict. A label with this name already exists (case-insensitive).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - bearerAuth: []
components:
  schemas:
    Label:
      type: object
      description: A label for organizing and categorizing documents and folders
      properties:
        name:
          type: string
          description: >
            The label name (2-25 characters).


            Names are case-insensitive: `"Production"` and `"production"` are
            considered the same.
          example: Production
        verified:
          type: boolean
          description: Whether the label is verified/curated
          example: true
        homepage:
          type: boolean
          description: Whether the label appears on the organization homepage
          example: false
        usage_count:
          type: integer
          description: Total number of documents and folders using this label
          example: 12
        color:
          type: string
          maxLength: 9
          default: null
          description: |
            Hex color for the label
          example: '#0366d6'
        description:
          type: string
          maxLength: 500
          default: null
          description: Description of the label
          example: Documents based on dev schemas
    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:
    TooManyRequests:
      description: Too Many Requests - Rate limit exceeded (60 requests/minute)
      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#personal-access-tokens-pat).


        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`

````