---
title: "Poll a Shorts Studio task"
method: GET
path: "/api/v1/shorts-studio"
tags: ["Advanced"]
---

# Poll a Shorts Studio task

`GET /api/v1/shorts-studio`

## Request

- Base URL: `https://viewmax.studio`
- URL: `https://viewmax.studio/api/v1/shorts-studio`
- Auth: HTTP bearer

Send exactly one of `taskId` or `requestId`.

## Query parameters

- `taskId` string
- `requestId` string, uuid

## Response `200`

Task status and artifacts.

- object
  - `code` 0, required
  - `message` 'ok', required
  - `data` ShortsStudioTask, required
    - `id` string, required
    - `status` 'pending' | 'processing' | 'success' | 'failed' | 'canceled', required
    - `phase` 'queued' | 'rendering' | 'completed' | 'failed', required
    - `costCredits` integer, required
    - `preset` 'comic_energy' | 'paper_collage' | 'product_clean'
    - `outputRatio` '9:16' | '16:9'
    - `videoUrl` string, uri: Preview MP4, present on success.
    - `artifacts` object[]: Present on success.
      - `kind` 'video' | 'text', required
      - `role` 'preview' | 'srt' | 'ass', required
      - `url` string, uri, required
      - `contentType` 'video/mp4' | 'application/x-subrip' | 'text/x-ass', required
    - `error` 'processing_failed': Present when the task failed.

## Other responses

- `400`: `invalid_request`: neither or both query parameters were sent.
- `401`: `unauthorized`.
- `404`: `task_not_found`.
- `500`: `processing_failed`.

---

[API](https://skmtc.dev/viewmax/apis/viewmax-studio-api.md) · [All operations](https://skmtc.dev/viewmax/apis/viewmax-studio-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viewmax/apis/viewmax-studio-api/revisions/c4f378e09f44?raw)