Skip to main content
POST
Create and queue insta swap

Authorizations

Authorization
string
header
required

Your organization API key starting with yph_sk_live_…

Path Parameters

id
string<uuid>
required

Body

application/json
actorId
string<uuid>
required

The unique identifier of the actor to replace the seed face/body with.

digitalSampleVariationId
string<uuid> | null
required

Assembled variation id for the render seed. null = original seed when ≤30s and enabled by the brand.

accountToken
string | null

Integrator token for this swap (creator or brand). Defaults to the actor's accountToken when omitted. When equal to the parent sample's accountToken, the swap is brand self-service (isBrandSelfService: true on the response).

Maximum string length: 128

Response

Swap task queued successfully

instaSwap
object

Insta swap render job. accountToken on the swap is the integrator id for whoever initiated it (creator or brand). sampleAccountToken and productToken are read from the parent digital sample. When isBrandSelfService is true, accountToken equals sampleAccountToken (brand-owned production, not a creator application).

Example: