Advanced

Compose a segmented video into a styled Short

Advanced. segmentationTaskId and transcriptTaskId come from person-segmentation and Auto Captions tasks created in the ViewMax web app; the REST API cannot create them. Applies a fixed preset and returns an asynchronous task (202) or the existing task for a repeated requestId (200). Costs 1 credit. Poll with GET on this path.

post/api/v1/shorts-studio

Request

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

Request body

requestIdstring uuid required

Client-generated idempotency id. The same id with the same body returns the existing task; with a different body it returns 409 request_conflict.

segmentationTaskIdstring required

Successful person-segmentation task created in the ViewMax web app.

transcriptTaskIdstring

Successful Auto Captions task created in the ViewMax web app for the same source video. Required when words is omitted.

preset'comic_energy' | 'paper_collage' | 'product_clean'
outputRatio'9:16' | '16:9'
backgroundColorstring
includeSrtboolean
includeAssboolean
creditLimitinteger required

Most credits this request may spend. The task costs 1 credit.

Response

Existing task for this requestId.

code0 required
message'ok' required

Changes

No recorded changes to this operation across all 1 revision of this API.