ShortsStudioRequest

CompanyArtificial IntelligenceVideoGenerationMarketing

Properties

Name	Type	Description
requestId	string	Client-generated idempotency id. The same id with the same body returns the existing task; with a different body it returns 409 `request_conflict`.
segmentationTaskId	string	Successful person-segmentation task created in the ViewMax web app.
transcriptTaskId	string	Successful Auto Captions task created in the ViewMax web app for the same source video. Required when `words` is omitted.
words	array	Word-level captions. Required when `transcriptTaskId` is omitted.
preset	string
outputRatio	string
backgroundColor	string
includeSrt	boolean
includeAss	boolean
creditLimit	integer	Most credits this request may spend. The task costs 1 credit.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/viewmax-studio/json-schema/viewmax-studio-shorts-studio-request-schema.json",
  "title": "ShortsStudioRequest",
  "x-generated": "2026-11-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/viewmax-studio-openapi.json#/components/schemas/ShortsStudioRequest",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "requestId",
    "segmentationTaskId",
    "creditLimit"
  ],
  "properties": {
    "requestId": {
      "type": "string",
      "format": "uuid",
      "description": "Client-generated idempotency id. The same id with the same body returns the existing task; with a different body it returns 409 `request_conflict`."
    },
    "segmentationTaskId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "Successful person-segmentation task created in the ViewMax web app."
    },
    "transcriptTaskId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "Successful Auto Captions task created in the ViewMax web app for the same source video. Required when `words` is omitted."
    },
    "words": {
      "type": "array",
      "minItems": 1,
      "maxItems": 4000,
      "description": "Word-level captions. Required when `transcriptTaskId` is omitted.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "text",
          "startMs",
          "endMs"
        ],
        "properties": {
          "text": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "startMs": {
            "type": "integer",
            "minimum": 0
          },
          "endMs": {
            "type": "integer",
            "minimum": 1
          },
          "speakerId": {
            "type": "string",
            "maxLength": 80
          }
        }
      }
    },
    "preset": {
      "type": "string",
      "enum": [
        "comic_energy",
        "paper_collage",
        "product_clean"
      ],
      "default": "comic_energy"
    },
    "outputRatio": {
      "type": "string",
      "enum": [
        "9:16",
        "16:9"
      ],
      "default": "9:16"
    },
    "backgroundColor": {
      "type": "string",
      "pattern": "^#[a-fA-F0-9]{6}$",
      "default": "#15202b"
    },
    "includeSrt": {
      "type": "boolean",
      "default": true
    },
    "includeAss": {
      "type": "boolean",
      "default": false
    },
    "creditLimit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Most credits this request may spend. The task costs 1 credit."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/viewmax-studio-shorts-studio-request"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.