Collections

Create a named mascot variant

Creates a draft from Original or source_variant_id. The source context and references are frozen. Supply reference_asset_id to use an existing collection image or your unassigned /v1/upload image and immediately approve the context, with no generation charge. Otherwise generate and approve a reference next. Reuse id for retries with the same inputs. This does not activate playback.

post/v1/collections/{id}/variants

Request

  • Base URL: https://api.masko.ai
  • URL: https://api.masko.ai/v1/collections/{id}/variants
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Headers

Idempotency-Keystring

Account-scoped key (1 to 255 characters, ideally a UUID). Retries must preserve the credential workspace, effective API version, URL, content type and exact body bytes, including multipart boundaries; different inputs return 409 idempotency_key_reused. Completed responses, including 500 errors, replay for 24 hours after completion with current resource access checked again. Running or unconfirmed executions return 409 idempotency_request_in_progress and do not expire automatically. A receipt persistence failure returns 503 idempotency_persistence_failed: retry only with the same key and inspect the operation outcome before starting a new request.

Request body

idstring uuid required

Client-generated UUID. Reuse it to safely retry creation.

namestring required
descriptionstring required

The desired change and generation guidance.

source_variant_idstring uuid

Approved variant to start from. Omit for Original. Its references and context are frozen on creation.

reference_asset_idstring uuid

Completed image in this collection, or your unassigned POST /v1/upload image. Creates an approved context immediately; no generation charge. Omit to create a draft for reference generation.

Response

Created variant

Changes

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