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

# Get a folder

> Returns one folder, including its `file_count`.



## OpenAPI

````yaml /openapi.yaml get /workspaces/{id}
openapi: 3.1.0
info:
  title: varg API
  version: 2.0.0
  description: |
    Unified REST API for AI media generation at `api.varg.ai/v2`.

    One API key, ~80 models across 8 providers, async jobs, stable output URLs
    on `s3.varg.ai`, files with lineage, and transparent credit billing
    (1 credit = 1 cent = $0.01).

    **The async job pattern:** every generation request returns `202 Accepted`
    with a job object (`status: queued`). Poll `GET /jobs/{id}` until the job
    reaches a terminal status (`completed`, `failed`, or `cancelled`), then read
    `output.outputs[0].url`. Alternatively, set `options.webhook_url` in the
    request to receive an HMAC-signed callback when the job finishes.
servers:
  - url: https://api.varg.ai/v2
security:
  - bearerAuth: []
tags:
  - name: Generation
    description: >-
      Create generation jobs (image, video, speech, music, transcription,
      ffmpeg, render, pipeline)
  - name: Tools
    description: Discover tools, their schemas, and call any tool generically
  - name: Jobs
    description: Poll and manage job lifecycle
  - name: Files
    description: Upload, import, probe, and manage files
  - name: Folders
    description: Group files into folders and file generated output automatically
  - name: Lineage
    description: Resolve which job produced a file
  - name: Presets
    description: Browse and apply reusable parameter values — voices, styles
  - name: Templates
    description: Browse, publish, use and render community templates
  - name: Pricing
    description: Estimate costs and browse the price catalog
  - name: Billing
    description: Balance, usage, and transaction history
  - name: Analytics
    description: >-
      Spend, runs and files over time — summaries, time series, breakdowns,
      activity
  - name: Account
    description: Identity and API key management
paths:
  /workspaces/{id}:
    get:
      tags:
        - Folders
      summary: Get a folder
      description: Returns one folder, including its `file_count`.
      operationId: getFolder
      parameters:
        - name: id
          in: path
          required: true
          description: Folder id (uuid) or slug.
          schema:
            type: string
          example: campaign-assets
      responses:
        '200':
          description: The folder
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Unknown folder (or not owned by the caller)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: workspace_not_found
                  message: Unknown workspace
components:
  schemas:
    FolderEnvelope:
      type: object
      required:
        - workspace
      properties:
        workspace:
          $ref: '#/components/schemas/Folder'
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: model_not_found
            message:
              type: string
              example: 'Unknown model: flux-shnell'
            details: {}
    Folder:
      type: object
      description: >-
        A folder that groups files. Folders are shared with the dashboard, so a
        folder created through the API appears in the web app.
      required:
        - id
        - name
        - slug
        - visibility
        - team_id
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: Campaign assets
        slug:
          type: string
          description: >-
            URL-safe identifier. Accepted anywhere a folder id is accepted. Not
            guaranteed unique.
          example: campaign-assets-3f9a1c2e
        visibility:
          type: string
          enum:
            - private
            - public
        team_id:
          type:
            - string
            - 'null'
          description: >-
            Set when the folder belongs to a team rather than a personal
            account.
        created_at:
          type: string
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
        file_count:
          type: integer
          description: >-
            Number of files in the folder. Only returned by create (always 0)
            and by get-one, not by the list endpoint.
  responses:
    Unauthorized:
      description: Missing or invalid API key / JWT
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              value:
                error:
                  code: unauthorized
                  message: Invalid or missing API key or JWT
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        varg API key (`varg_...`). Get one at [app.varg.ai](https://app.varg.ai)
        or run `bunx vargai login`. App sessions may alternatively send a
        Supabase JWT.

````

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