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

# Get current workspace

> Returns information about the workspace this API key represents — name, plan, credit balance, member count and the role of the user who created the key. Each API key is bound to a single workspace; to operate on a different workspace, create a separate key from inside that workspace.



## OpenAPI

````yaml https://api.cut.pro/api/v1/openapi.json get /workspace
openapi: 3.0.3
info:
  title: CutPro API
  version: 1.0.0
  description: >-
    The CutPro API lets you automate AI-powered video clipping and rendering
    programmatically.


    ## Typical workflow


    1. **Analyze** a public video URL to preview metadata and credit cost — no
    charge (`POST /clips/info`)

    2. **Submit** the video for AI clipping — credits are deducted immediately
    (`POST /clips`)

    3. **Poll** the submission until `status` is `completed` or `failed` (`GET
    /clips/{videoId}/submissions/{submissionId}`)

    4. **Fetch** the AI-generated highlight clips (`GET
    /clips/{videoId}/submissions/{submissionId}/clips`)

    5. **Optionally** apply one of your templates in bulk (`POST
    /clips/{videoId}/submissions/{submissionId}/apply_template`)

    6. **Render** each clip to a final MP4 (`POST
    /clips/{videoId}/submissions/{submissionId}/clips/{clipId}/render`)

    7. **Poll** the render until `status` is `completed` (`GET
    /renders/{renderId}`)

    8. **Download** the rendered video (`GET /renders/{renderId}/download`)


    ## Authentication


    Pass your API key on every request via the `X-Api-Key` header or as
    `Authorization: Bearer <key>`.

    You can generate API keys from your account settings at
    [cut.pro](https://cut.pro).


    ## Workspaces


    An API key is bound to one or more workspaces (Cloudflare-style scoped
    tokens).


    - **Single-workspace key**: every request operates on that workspace
    automatically. No header needed.

    - **Multi-workspace key**: pass `X-Workspace-Id: <workspace-id>` on every
    request to pick which workspace
      the call hits. Without the header, you get `400 MISSING_WORKSPACE_ID` with the list of allowed
      workspace ids in the response.

    Call `GET /workspace` to inspect the workspace the current request resolved
    to, plus its plan and role.


    ## Credits


    Credits are consumed when a submission is created. Check the workspace
    balance at `GET /balance`.

    Use `POST /clips/info` to see the exact cost before committing.
servers:
  - url: https://api.cut.pro/api/v1
security: []
tags:
  - name: Workspace
    description: >-
      The workspace this request resolved to. Single-workspace keys always
      resolve to their bound workspace. Multi-workspace keys resolve via the
      `X-Workspace-Id` header — credits, submissions, clips and renders belong
      to whichever workspace the header selects on each request.
  - name: Videos
    description: >-
      Your clipping library — the source videos you have submitted for AI
      clipping.
  - name: Submissions
    description: >-
      Clipping jobs — the full lifecycle from pre-flight analysis through AI
      processing to completion. Each submission is tied to a video and produces
      a set of generated clips when it completes.
  - name: Clips
    description: >-
      AI-generated highlight clips produced by a completed submission. Each clip
      includes timestamps, a relevance score, and signed URLs for streaming and
      downloading. Clips can have a template applied and then be rendered to a
      final MP4.
  - name: Renders
    description: >-
      Video render jobs. After optionally applying a template to a clip, start a
      render to produce a final MP4. Poll the render until completed, then
      download the file.
  - name: Posts
    description: >-
      Multi-platform publishing. Create a post that references one or more
      edited clips plus the social connections to publish to, then poll it
      through `pending → processing → completed`. Failed items can be retried or
      removed without disturbing siblings that already published.
  - name: Templates
    description: >-
      Video editing templates that apply visual effects, captions, cropping, and
      other styles to clips in bulk. List your templates to find an ID to pass
      to `apply_template`.
  - name: Balance
    description: >-
      Credit balance and ledger of the workspace this API key represents.
      Credits are consumed when you create a submission. For full workspace
      metadata (plan, seats, role, member count) see `GET /workspace`.
  - name: Connections
    description: >-
      Social media accounts connected to this workspace — the IDs you pass as
      `connection_id` when creating a post. To connect a new account, sign in at
      [cut.pro](https://cut.pro) and use the in-app OAuth flow; connection
      lifecycle is not exposed via API.
paths:
  /workspace:
    get:
      tags:
        - Workspace
      summary: Get current workspace
      description: >-
        Returns information about the workspace this API key represents — name,
        plan, credit balance, member count and the role of the user who created
        the key. Each API key is bound to a single workspace; to operate on a
        different workspace, create a separate key from inside that workspace.
      operationId: getWorkspace
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - name
                  - is_personal
                  - status
                  - role
                  - plan_id
                  - plan_name
                  - plan_is_free
                  - credits
                  - seat_count
                  - max_total_seats
                  - member_count
                  - created_at
                properties:
                  id:
                    description: Unique workspace ID
                    type: string
                  name:
                    description: Workspace name
                    type: string
                  is_personal:
                    description: >-
                      `true` if this is the user's personal workspace, `false`
                      if it is a team workspace
                    type: boolean
                  status:
                    description: Workspace status — typically `active`
                    type: string
                  role:
                    type: string
                    enum:
                      - admin
                      - member
                  plan_id:
                    description: ID of the current subscription plan
                    type: string
                  plan_name:
                    description: Display name of the current plan
                    type: string
                    nullable: true
                  plan_is_free:
                    description: '`true` if the workspace is on the free plan'
                    type: boolean
                  credits:
                    description: Current credit balance for this workspace
                    type: number
                  seat_count:
                    description: Extra purchased seats (legacy; sempre 0)
                    type: number
                  max_total_seats:
                    description: >-
                      Maximum total seats available on the current plan,
                      including any plan-included free seats
                    type: number
                  member_count:
                    description: >-
                      Total members currently in the workspace, including the
                      owner
                    type: number
                  created_at:
                    description: ISO 8601 timestamp of when the workspace was created
                    type: string
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    enum:
                      - WORKSPACE_NOT_FOUND
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key

````