Update digital sample

curl --request PATCH \
  --url https://api.yourproducthere.ai/v1/digital-samples/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "positiveRenderPrompt": "<string>",
  "negativeRenderPrompt": "<string>",
  "renderVoiceConversionEnabled": true,
  "seedVideoUrl": "<string>",
  "seedVideoDurationSec": 123,
  "accountToken": "<string>",
  "productToken": "<string>"
}
'

import requests

url = "https://api.yourproducthere.ai/v1/digital-samples/{id}"

payload = {
    "title": "<string>",
    "description": "<string>",
    "positiveRenderPrompt": "<string>",
    "negativeRenderPrompt": "<string>",
    "renderVoiceConversionEnabled": True,
    "seedVideoUrl": "<string>",
    "seedVideoDurationSec": 123,
    "accountToken": "<string>",
    "productToken": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    description: '<string>',
    positiveRenderPrompt: '<string>',
    negativeRenderPrompt: '<string>',
    renderVoiceConversionEnabled: true,
    seedVideoUrl: '<string>',
    seedVideoDurationSec: 123,
    accountToken: '<string>',
    productToken: '<string>'
  })
};

fetch('https://api.yourproducthere.ai/v1/digital-samples/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yourproducthere.ai/v1/digital-samples/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'positiveRenderPrompt' => '<string>',
    'negativeRenderPrompt' => '<string>',
    'renderVoiceConversionEnabled' => true,
    'seedVideoUrl' => '<string>',
    'seedVideoDurationSec' => 123,
    'accountToken' => '<string>',
    'productToken' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.yourproducthere.ai/v1/digital-samples/{id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"positiveRenderPrompt\": \"<string>\",\n  \"negativeRenderPrompt\": \"<string>\",\n  \"renderVoiceConversionEnabled\": true,\n  \"seedVideoUrl\": \"<string>\",\n  \"seedVideoDurationSec\": 123,\n  \"accountToken\": \"<string>\",\n  \"productToken\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.yourproducthere.ai/v1/digital-samples/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"positiveRenderPrompt\": \"<string>\",\n  \"negativeRenderPrompt\": \"<string>\",\n  \"renderVoiceConversionEnabled\": true,\n  \"seedVideoUrl\": \"<string>\",\n  \"seedVideoDurationSec\": 123,\n  \"accountToken\": \"<string>\",\n  \"productToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.yourproducthere.ai/v1/digital-samples/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"positiveRenderPrompt\": \"<string>\",\n  \"negativeRenderPrompt\": \"<string>\",\n  \"renderVoiceConversionEnabled\": true,\n  \"seedVideoUrl\": \"<string>\",\n  \"seedVideoDurationSec\": 123,\n  \"accountToken\": \"<string>\",\n  \"productToken\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "digitalSample": {
    "id": "d3b07384-d113-4956-a5e2-416b2a41bc3c",
    "orgId": "org_123abc",
    "title": "Summer Vacation",
    "description": "Outdoor digital sample for summer looks",
    "positiveRenderPrompt": "cinematic sunset, detailed face, 8k",
    "negativeRenderPrompt": "blurry, low quality, bad hands",
    "renderSeedFps": 30,
    "renderVoiceConversionEnabled": true,
    "renderEntryWidth": 720,
    "seedVideoUrl": "https://cdn.example.com/seeds/summer.mp4",
    "signedSeedVideoUrl": "https://account.r2.cloudflarestorage.com/bucket/seed-assets/sample.mp4?X-Amz-Signature=...",
    "seedAssetPending": false,
    "seedVideoDurationSec": 15,
    "status": "ACTIVE",
    "videoReviewStatus": "APPROVED",
    "accountToken": "brand_nike",
    "productToken": "sku_air_max_90",
    "createdAt": "2026-06-20T12:00:00Z",
    "updatedAt": "2026-06-20T12:05:00Z"
  }
}

Digital Samples

Update digital sample

Update configuration, prompts, advanced render parameters, or title/description of an existing digital sample. All fields in the body are optional.

Seed Video Replacement Policy: If seedVideoUrl is provided, it replaces the current seed video. Note that replacing the seed video of a digital sample with active collaborations is blocked (returns 409 Conflict) to safeguard operational consistency. If a seed video is successfully replaced, any existing unlinked or old seed video is safely replaced in the database.

On an ACTIVE sample, replacing the seed may demote the sample to DRAFT and disable collab/public flags until the new seed is re-validated.

PATCH

digital-samples

{id}

Update digital sample

curl --request PATCH \
  --url https://api.yourproducthere.ai/v1/digital-samples/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "positiveRenderPrompt": "<string>",
  "negativeRenderPrompt": "<string>",
  "renderVoiceConversionEnabled": true,
  "seedVideoUrl": "<string>",
  "seedVideoDurationSec": 123,
  "accountToken": "<string>",
  "productToken": "<string>"
}
'

import requests

url = "https://api.yourproducthere.ai/v1/digital-samples/{id}"

payload = {
    "title": "<string>",
    "description": "<string>",
    "positiveRenderPrompt": "<string>",
    "negativeRenderPrompt": "<string>",
    "renderVoiceConversionEnabled": True,
    "seedVideoUrl": "<string>",
    "seedVideoDurationSec": 123,
    "accountToken": "<string>",
    "productToken": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    description: '<string>',
    positiveRenderPrompt: '<string>',
    negativeRenderPrompt: '<string>',
    renderVoiceConversionEnabled: true,
    seedVideoUrl: '<string>',
    seedVideoDurationSec: 123,
    accountToken: '<string>',
    productToken: '<string>'
  })
};

fetch('https://api.yourproducthere.ai/v1/digital-samples/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yourproducthere.ai/v1/digital-samples/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'positiveRenderPrompt' => '<string>',
    'negativeRenderPrompt' => '<string>',
    'renderVoiceConversionEnabled' => true,
    'seedVideoUrl' => '<string>',
    'seedVideoDurationSec' => 123,
    'accountToken' => '<string>',
    'productToken' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.yourproducthere.ai/v1/digital-samples/{id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"positiveRenderPrompt\": \"<string>\",\n  \"negativeRenderPrompt\": \"<string>\",\n  \"renderVoiceConversionEnabled\": true,\n  \"seedVideoUrl\": \"<string>\",\n  \"seedVideoDurationSec\": 123,\n  \"accountToken\": \"<string>\",\n  \"productToken\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.yourproducthere.ai/v1/digital-samples/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"positiveRenderPrompt\": \"<string>\",\n  \"negativeRenderPrompt\": \"<string>\",\n  \"renderVoiceConversionEnabled\": true,\n  \"seedVideoUrl\": \"<string>\",\n  \"seedVideoDurationSec\": 123,\n  \"accountToken\": \"<string>\",\n  \"productToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.yourproducthere.ai/v1/digital-samples/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"positiveRenderPrompt\": \"<string>\",\n  \"negativeRenderPrompt\": \"<string>\",\n  \"renderVoiceConversionEnabled\": true,\n  \"seedVideoUrl\": \"<string>\",\n  \"seedVideoDurationSec\": 123,\n  \"accountToken\": \"<string>\",\n  \"productToken\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "digitalSample": {
    "id": "d3b07384-d113-4956-a5e2-416b2a41bc3c",
    "orgId": "org_123abc",
    "title": "Summer Vacation",
    "description": "Outdoor digital sample for summer looks",
    "positiveRenderPrompt": "cinematic sunset, detailed face, 8k",
    "negativeRenderPrompt": "blurry, low quality, bad hands",
    "renderSeedFps": 30,
    "renderVoiceConversionEnabled": true,
    "renderEntryWidth": 720,
    "seedVideoUrl": "https://cdn.example.com/seeds/summer.mp4",
    "signedSeedVideoUrl": "https://account.r2.cloudflarestorage.com/bucket/seed-assets/sample.mp4?X-Amz-Signature=...",
    "seedAssetPending": false,
    "seedVideoDurationSec": 15,
    "status": "ACTIVE",
    "videoReviewStatus": "APPROVED",
    "accountToken": "brand_nike",
    "productToken": "sku_air_max_90",
    "createdAt": "2026-06-20T12:00:00Z",
    "updatedAt": "2026-06-20T12:05:00Z"
  }
}

Authorizations

Authorization

string

header

required

Your organization API key starting with yph_sk_live_…

Path Parameters

string<uuid>

required

Body

application/json

title

string

Optional updated title (Max 120 characters).

Maximum string length: 120

description

string | null

Optional description (Max 300 characters).

Maximum string length: 300

status

enum<string>

Optional updated lifecycle status. Updating to ARCHIVED soft-deletes the sample and permanently blocks any new InstaSwap creations for it.

Available options:

DRAFT,

ACTIVE,

ARCHIVED

positiveRenderPrompt

string | null

Optional custom positive render prompt (Max 2000 characters).

Maximum string length: 2000

negativeRenderPrompt

string | null

Optional custom negative render prompt (Max 2000 characters).

Maximum string length: 2000

renderSeedFps

enum<integer>

Optional updated seed FPS tier.

Available options:

16,

24,

30

renderVoiceConversionEnabled

boolean

Optional updated CosyVoice replacement status.

renderEntryWidth

enum<integer>

Optional updatedPortrait 9:16 analysis size.

Available options:

480,

720

seedVideoUrl

string<uri> | null

Optional public HTTPS URL of a new seed video. YPH securely ingests and validates the file. Echoed in responses; use signedSeedVideoUrl to preview. Pass null to clear the seed.

seedVideoDurationSec

integer | null

Optional duration in seconds for the replaced seed (must be 170 seconds or less).

Required range: x <= 170

accountToken

string | null

Optional updated brand accountToken (pass null to clear).

Maximum string length: 128

productToken

string | null

Optional updated catalog productToken (pass null to clear).

Maximum string length: 128

Response

Updated successfully

digitalSample

object

Digital sample resource returned by GET, POST, and PATCH.

Write-only (POST/PATCH body): seedVideoUrl — your public HTTPS source URL. YPH ingests a copy into private storage. Use the presigned upload flow (/seed/upload-url + /seed/register) when uploading directly.
Read-only (responses): signedSeedVideoUrl — short-lived presigned GET URL for preview/download. Never send this back on PATCH.
Echo (responses): seedVideoUrl repeats the external source URL you submitted (null when the seed was uploaded via presigned PUT or created in the YPH app).
Integrator identity: accountToken identifies the brand (your marketplace advertiser). productToken is your internal catalog product id. See Integrator tokens.
Credits: Org credit balance is not on this resource — use GET /account (creditBalance).

Show child attributes

Example:

{
  "id": "d3b07384-d113-4956-a5e2-416b2a41bc3c",
  "orgId": "org_123abc",
  "title": "Summer Vacation",
  "description": "Outdoor digital sample for summer looks",
  "positiveRenderPrompt": "cinematic sunset, detailed face, 8k",
  "negativeRenderPrompt": "blurry, low quality, bad hands",
  "renderSeedFps": 30,
  "renderVoiceConversionEnabled": true,
  "renderEntryWidth": 720,
  "seedVideoUrl": "https://cdn.example.com/seeds/summer.mp4",
  "signedSeedVideoUrl": "https://account.r2.cloudflarestorage.com/bucket/seed-assets/sample.mp4?X-Amz-Signature=...",
  "seedAssetPending": false,
  "seedVideoDurationSec": 15,
  "status": "ACTIVE",
  "videoReviewStatus": "APPROVED",
  "accountToken": "brand_nike",
  "productToken": "sku_air_max_90",
  "createdAt": "2026-06-20T12:00:00Z",
  "updatedAt": "2026-06-20T12:05:00Z"
}

System

Account

Actors

Digital Samples

Insta Swaps

Webhooks

Update digital sample

Authorizations

Path Parameters

Body

Response