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

# Get Volume Endpoint

> Get a volume by name, in the caller's scope.



## OpenAPI

````yaml https://api.primeintellect.ai/api/v1/sandbox/openapi.json get /api/v1/sandbox/volumes/{name}
openapi: 3.1.0
info:
  title: PI API
  version: 0.1.0
servers:
  - url: https://api.primeintellect.ai
security: []
paths:
  /api/v1/sandbox/volumes/{name}:
    get:
      tags:
        - Sandbox Volumes
      summary: Get Volume Endpoint
      description: Get a volume by name, in the caller's scope.
      operationId: get_volume_endpoint_api_v1_sandbox_volumes__name__get
      parameters:
        - name: name
          in: path
          required: true
          schema:
            type: string
            title: Name
        - name: team_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Resolve the name in this team's scope
            title: Team Id
          description: Resolve the name in this team's scope
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeResponse'
        '401':
          description: Authorization failed
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    VolumeResponse:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: User Id
        team_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Team Id
        head_checkpoint_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Head Checkpoint Id
        created_at:
          type: string
          format: date-time
          title: Created At
        occupied_bytes:
          type: integer
          title: Occupied Bytes
          default: 0
        size_gb:
          type: integer
          title: Size Gb
          default: 100
        account_storage_used_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Account Storage Used Bytes
        account_storage_limit_gb:
          anyOf:
            - type: integer
            - type: 'null'
          title: Account Storage Limit Gb
      type: object
      required:
        - id
        - name
        - created_at
      title: VolumeResponse
      description: |-
        One volume, scoped to its single owner (exactly one of user/team).

        occupied_bytes is the current published version's non-hole uncompressed
        size (the head checkpoint's occupiedBytes). The GET response fills the
        account fields with the caller's volume-storage usage (bytes) and wallet
        limit (whole GiB); list items leave them null and the page-level
        VolumeListResponse carries them instead. occupied_bytes defaults to 0
        legitimately: create_volume returns a bare Volume row (nothing published
        yet, no head to join), and list/get/resize rows carry the joined head
        bytes.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````