> ## 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 new instance workspace

> Create a new instance workspace.



## OpenAPI

````yaml /api-reference/openapi-v3-instance.yaml post /api/v3/instance/workspaces
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v3-instance)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Workspaces
    description: Operations about workspaces
paths:
  /api/v3/instance/workspaces:
    post:
      tags:
        - Workspaces
      summary: Create a new instance workspace
      description: Create a new instance workspace.
      operationId: api_v3_instance_workspaces_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstanceWorkspaceCreateV3Request'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/InstanceWorkspaceCreateV3Request'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/InstanceWorkspaceCreateV3Request'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceWorkspaceV3DetailsResponse'
          description: Instance workspace created successfully
        '400':
          description: Invalid input
        '401':
          description: Authentication failed - missing or invalid API key
        '403':
          description: Permission denied - insufficient rights to create instance workspace
      security:
        - bearerAuth: []
components:
  schemas:
    InstanceWorkspaceCreateV3Request:
      type: object
      description: Serializer for creating an instance workspace (custom only).
      properties:
        name:
          type: string
          maxLength: 100
        description:
          type: string
          default: ''
        workspace_type:
          $ref: '#/components/schemas/WorkspaceTypeEnum'
        document_upload_method:
          $ref: '#/components/schemas/DocumentUploadMethodEnum'
        company_id:
          type: integer
      required:
        - company_id
        - name
    InstanceWorkspaceV3DetailsResponse:
      type: object
      description: V3 Response serializer for instance-level workspace operations.
      properties:
        id:
          type: integer
        name:
          type: string
        workspace_type:
          type: string
        document_upload_method:
          type: string
        description:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        user_role:
          type: string
          readOnly: true
        used_storage:
          type: number
          format: double
        files_count:
          type: integer
        company:
          $ref: '#/components/schemas/WorkspaceCompany'
      required:
        - company
        - created_at
        - description
        - document_upload_method
        - files_count
        - id
        - name
        - updated_at
        - used_storage
        - user_role
        - workspace_type
    WorkspaceTypeEnum:
      enum:
        - custom
      type: string
      description: '* `custom` - custom'
    DocumentUploadMethodEnum:
      enum:
        - manual
        - synced
      type: string
      description: |-
        * `manual` - Manual
        * `synced` - Synced
    WorkspaceCompany:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
        - id
        - name
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````