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

# Create Workspace

> Create a workspace for one of your clients.
Its `id` and your `externalId` both work in the `X-Clustr-Tenant` header of the public API.

**Scope:** `tenants:write`.




## OpenAPI

````yaml /enterprise/openapi.yaml post /tenants
openapi: 3.1.0
info:
  title: Clustr Organization API
  description: >
    Organization-level operations for partners who run Clustr for many clients:
    workspaces, the

    signed webhook, usage and contract limits, erasure and the audit log.


    This API covers the organization only. Everything a workspace does (imports,
    jobs, search,

    saved views, tags) is the public API at
    `https://api.clustr-ai.com/api/public`, called with the

    organization key and an `X-Clustr-Tenant` header.


    ## Authentication

    Every endpoint needs an organization API key (it starts with `clo_`) in the

    `Authorization` header.


    ```

    Authorization: Bearer clo_...

    ```


    Clustr staff create organization keys. Each key carries scopes; an operation
    that needs a

    scope the key lacks answers `403`.
  version: '1.0'
  contact:
    name: Clustr Support
    url: https://clustr-ai.com
servers:
  - url: https://api.clustr-ai.com/api/org/v1
    description: Production
security:
  - OrgKey: []
tags:
  - name: Workspaces
    description: >-
      Create, read, rename, suspend, resume and delete the workspaces of your
      organization.
  - name: Webhook
    description: The organization's signed webhook, its secret and its deliveries.
  - name: Usage and limits
    description: >-
      What your organization used, the monthly statement, and your contract
      limits.
  - name: Erasure
    description: Remove one person from every workspace of the organization.
  - name: Audit log
    description: The organization's own record of every call.
paths:
  /tenants:
    post:
      tags:
        - Workspaces
      summary: Create Workspace
      description: >
        Create a workspace for one of your clients.

        Its `id` and your `externalId` both work in the `X-Clustr-Tenant` header
        of the public API.


        **Scope:** `tenants:write`.
      operationId: createWorkspace
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkspaceRequest'
            examples:
              workspace:
                summary: A client workspace
                value:
                  name: Acme
                  externalId: client-1234
      responses:
        '201':
          description: The workspace was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponse'
              example:
                success: true
                data:
                  id: 3f6c1d2e-8a4b-4c1f-9e2d-7b5a0c9e1f42
                  name: Acme
                  externalId: client-1234
                  createdAt: '2026-10-13T09:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/ExternalIdTaken'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '502':
          $ref: '#/components/responses/BadGateway'
components:
  schemas:
    CreateWorkspaceRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          description: The workspace's name.
          example: Acme
        externalId:
          type: string
          description: >-
            Your own id for the client. Unique in your organization; a duplicate
            answers `409`.
          example: client-1234
    WorkspaceResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Workspace'
    Workspace:
      type: object
      description: A workspace of your organization.
      required:
        - id
        - name
        - createdAt
      properties:
        id:
          type: string
          format: uuid
          description: >-
            The workspace id. Use it, or your `externalId`, in
            `X-Clustr-Tenant`.
          example: 3f6c1d2e-8a4b-4c1f-9e2d-7b5a0c9e1f42
        name:
          type: string
          example: Acme
        externalId:
          type: string
          description: >-
            Your own id for the workspace, unique in your organization. Omitted
            when not set.
          example: client-1234
        suspendedAt:
          type: string
          format: date-time
          description: When the workspace was suspended. Omitted when it is not suspended.
        createdAt:
          type: string
          format: date-time
          example: '2026-10-13T09:30:00Z'
    ErrorResponse:
      type: object
      description: >-
        Every error has this shape. Branch on `error.code`; `error.message` is
        for people.
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                A stable code to branch on, such as `BAD_REQUEST`, `NOT_FOUND`
                or `CONFLICT`.
              example: BAD_REQUEST
            message:
              type: string
              description: A sentence a person can read.
              example: Invalid request body.
            request_id:
              type: string
              description: Quote it to Clustr support.
  responses:
    BadRequest:
      description: The request is not valid. `error.message` says what to fix.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: BAD_REQUEST
              message: Invalid request body.
    Unauthorized:
      description: >-
        The key is missing, invalid or revoked, or it is not an organization
        key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Invalid or revoked API key
    Forbidden:
      description: The key lacks the scope this operation needs.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: FORBIDDEN
              message: This key lacks the tenants:write scope
    ExternalIdTaken:
      description: Another workspace of your organization already has this `externalId`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: CONFLICT
              message: This external ID is already used in the organization.
    TooManyRequests:
      description: >-
        Your organization is over its rate limit. The limit is shared by all
        keys and workspaces of the organization. Wait for `Retry-After`, then
        retry.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: RATE_LIMITED
              message: Too many requests
    BadGateway:
      description: The organization service could not be reached. Retry later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UPSTREAM_UNAVAILABLE
              message: The organization service is unavailable
  headers:
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
    RateLimitLimit:
      description: Requests per second allowed for your organization.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window. Always `0` on a `429`.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time (seconds) when requests are allowed again.
      schema:
        type: integer
  securitySchemes:
    OrgKey:
      type: http
      scheme: bearer
      description: >-
        Organization API key (`clo_...`). The `X-API-Key` header is also
        accepted in place of `Authorization: Bearer`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.