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

# Create a user group

> This endpoint allows company admins to create a new user group.

SysAdmin/instance-level users can specify company_id to create groups in any company.

Regular company admins can only create groups in their own company.



## OpenAPI

````yaml /api-reference/openapi-v3.yaml post /api/v3/groups
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v3)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Agents
    description: Operations about agents
  - name: Threads
    description: Operations about agents conversation threads
  - name: Tools
    description: Operations about native tools
  - name: Models
    description: Operations about AI models
  - name: MCP
    description: Operations about MCP servers
  - name: Sources
    description: Operations about sources used by agents conversation threads
  - name: Artifacts
    description: Operations about artifacts generated by agents conversation threads
  - name: Agent
    description: >-
      Operations about agents (deprecated). Please use the 'Agents' API
      component instead.
  - name: Files
    description: Operations about files
  - name: Files Processing
    description: Operations about files processing
  - name: Tags
    description: Operations about tags
  - name: Workspaces
    description: Operations about workspaces
  - name: Users
    description: Operations about users
  - name: User Groups
    description: Operations about user groups
  - name: Companies
    description: Operations about companies
  - name: SCIM
    description: Operations about SCIM
paths:
  /api/v3/groups:
    post:
      tags:
        - User Groups
      summary: Create a user group
      description: >-
        This endpoint allows company admins to create a new user group.


        SysAdmin/instance-level users can specify company_id to create groups in
        any company.


        Regular company admins can only create groups in their own company.
      operationId: api_v3_groups_create
      parameters:
        - in: query
          name: company_id
          schema:
            type: integer
          description: Company ID (only for SysAdmin/instance-level users)
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateGroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateGroupRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupCreateResponse'
          description: Group created successfully
        '400':
          description: Invalid input (empty name, invalid user IDs)
        '403':
          description: Insufficient permissions
        '404':
          description: Company or users not found
        '409':
          description: Group name already exists in the target company
      security:
        - bearerAuth: []
components:
  schemas:
    CreateGroupRequest:
      type: object
      description: 'V3 API: Create a new user group'
      properties:
        name:
          type: string
          description: Name of the group
          maxLength: 255
        description:
          type: string
          nullable: true
          description: Description of the group
        user_ids:
          type: array
          items:
            type: integer
          description: List of user IDs to add to the group as members
      required:
        - name
    GroupCreateResponse:
      type: object
      description: |-
        V3 Response serializer for group creation.
        Returns basic group information with user IDs.
      properties:
        id:
          type: integer
        company_id:
          type: integer
        category:
          type: string
        name:
          type: string
        description:
          type: string
        user_ids:
          type: string
          readOnly: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - category
        - company_id
        - created_at
        - description
        - id
        - name
        - updated_at
        - user_ids
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````