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

# Clone a workspace



## OpenAPI

````yaml /openapi.yaml post /v1/workspaces/{workspace_id}/clone
openapi: 3.1.0
info:
  title: Mirage API
  version: '0.1'
servers:
  - url: http://127.0.0.1:8765
    description: A local daemon on its default port
security:
  - bearerAuth: []
paths:
  /v1/workspaces/{workspace_id}/clone:
    post:
      tags:
        - Snapshots
      summary: Clone a workspace
      operationId: clone_workspace_v1_workspaces__workspace_id__clone_post
      parameters:
        - $ref: '#/components/parameters/workspaceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneWorkspaceRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceDetail'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '429':
          $ref: '#/components/responses/429'
components:
  parameters:
    workspaceId:
      name: workspace_id
      in: path
      required: true
      description: The workspace's id.
      schema:
        type: string
  schemas:
    CloneWorkspaceRequest:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
        override:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Override
      additionalProperties: false
      type: object
      title: CloneWorkspaceRequest
    WorkspaceDetail:
      properties:
        id:
          type: string
          title: Id
        mode:
          type: string
          title: Mode
        created_at:
          type: number
          title: Created At
        fuse_mountpoints:
          additionalProperties:
            type: string
          type: object
          title: Fuse Mountpoints
        system_time:
          anyOf:
            - type: string
            - type: 'null'
          title: System Time
        sessions:
          items:
            $ref: '#/components/schemas/SessionSummary'
          type: array
          title: Sessions
        mounts:
          items:
            $ref: '#/components/schemas/MountSummary'
          type: array
          title: Mounts
        internals:
          anyOf:
            - $ref: '#/components/schemas/WorkspaceInternals'
            - type: 'null'
      type: object
      required:
        - id
        - mode
        - created_at
      title: WorkspaceDetail
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SessionSummary:
      properties:
        session_id:
          type: string
          title: Session Id
        cwd:
          type: string
          title: Cwd
      type: object
      required:
        - session_id
        - cwd
      title: SessionSummary
    MountSummary:
      properties:
        prefix:
          type: string
          title: Prefix
        vfs:
          type: string
          title: Vfs
        mode:
          type: string
          title: Mode
        description:
          type: string
          title: Description
          default: ''
      type: object
      required:
        - prefix
        - vfs
        - mode
      title: MountSummary
    WorkspaceInternals:
      properties:
        cache_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cache Bytes
        cache_entries:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cache Entries
        history_length:
          type: integer
          title: History Length
        in_flight_jobs:
          type: integer
          title: In Flight Jobs
      type: object
      required:
        - cache_bytes
        - cache_entries
        - history_length
        - in_flight_jobs
      title: WorkspaceInternals
    Error:
      type: object
      properties:
        detail:
          description: What went wrong, as text or a structured record.
        errno:
          type: string
          description: The errno of a failed file call, such as ENOENT.
        refusal:
          type: object
          description: The policy refusal, when a policy refused the call.
      required:
        - detail
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  responses:
    '401':
      description: The token is missing or wrong
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
        text/plain:
          schema:
            type: string
            description: The Python daemon answers Unauthorized as plain text.
    '404':
      description: The workspace, session, job or file does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '429':
      description: Past a rate limit, or a new session past max_sessions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            minimum: 0
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The server's token (MIRAGE_AUTH_TOKEN) or a JWT. A daemon in the default
        local mode with no token accepts requests without one.

````

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