Create digital sample

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

import requests

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

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

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

print(response.text)

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

fetch('https://api.yourproducthere.ai/v1/digital-samples', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'seedVideoUrl' => '<string>',
    'seedVideoDurationSec' => 123,
    'positiveRenderPrompt' => '<string>',
    'negativeRenderPrompt' => '<string>',
    'renderSeedFps' => 16,
    'renderVoiceConversionEnabled' => true,
    'renderEntryWidth' => 480,
    '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"

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

	req, _ := http.NewRequest("POST", 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.post("https://api.yourproducthere.ai/v1/digital-samples")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"seedVideoUrl\": \"<string>\",\n  \"seedVideoDurationSec\": 123,\n  \"positiveRenderPrompt\": \"<string>\",\n  \"negativeRenderPrompt\": \"<string>\",\n  \"renderSeedFps\": 16,\n  \"renderVoiceConversionEnabled\": true,\n  \"renderEntryWidth\": 480,\n  \"accountToken\": \"<string>\",\n  \"productToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"seedVideoUrl\": \"<string>\",\n  \"seedVideoDurationSec\": 123,\n  \"positiveRenderPrompt\": \"<string>\",\n  \"negativeRenderPrompt\": \"<string>\",\n  \"renderSeedFps\": 16,\n  \"renderVoiceConversionEnabled\": true,\n  \"renderEntryWidth\": 480,\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"
  }
}

POST

digital-samples

Create digital sample

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

import requests

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

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

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

print(response.text)

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

fetch('https://api.yourproducthere.ai/v1/digital-samples', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'seedVideoUrl' => '<string>',
    'seedVideoDurationSec' => 123,
    'positiveRenderPrompt' => '<string>',
    'negativeRenderPrompt' => '<string>',
    'renderSeedFps' => 16,
    'renderVoiceConversionEnabled' => true,
    'renderEntryWidth' => 480,
    '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"

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

	req, _ := http.NewRequest("POST", 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.post("https://api.yourproducthere.ai/v1/digital-samples")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"seedVideoUrl\": \"<string>\",\n  \"seedVideoDurationSec\": 123,\n  \"positiveRenderPrompt\": \"<string>\",\n  \"negativeRenderPrompt\": \"<string>\",\n  \"renderSeedFps\": 16,\n  \"renderVoiceConversionEnabled\": true,\n  \"renderEntryWidth\": 480,\n  \"accountToken\": \"<string>\",\n  \"productToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"seedVideoUrl\": \"<string>\",\n  \"seedVideoDurationSec\": 123,\n  \"positiveRenderPrompt\": \"<string>\",\n  \"negativeRenderPrompt\": \"<string>\",\n  \"renderSeedFps\": 16,\n  \"renderVoiceConversionEnabled\": true,\n  \"renderEntryWidth\": 480,\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_…

Body

application/json

title

string

Optional custom title. If omitted, defaults to "API Sample ". (Max 120 characters)

Maximum string length: 120

description

string | null

Optional description of the sample. (Max 300 characters)

Maximum string length: 300

seedVideoUrl

string<uri>

Optional public HTTPS URL to initialize the sample. YPH securely copies the file to R2, validates format and duration (≤170s), and automatically activates the sample. Echoed in responses; use signedSeedVideoUrl to preview the ingested copy.

seedVideoDurationSec

integer | null

Optional duration in seconds. Must be 170 seconds or less.

Required range: x <= 170

positiveRenderPrompt

string

Optional custom positive render prompt for the Wan model. Defaults to standard actor-replacement prompt. (Max 2000 characters)

Maximum string length: 2000

negativeRenderPrompt

string

Optional custom negative render prompt for the Wan model. Defaults to standard actor-replacement negative prompt. (Max 2000 characters)

Maximum string length: 2000

renderSeedFps

enum<integer>

default:16

Optional seed FPS tier (16 Economy, 24 Balanced, 30 Premium Quality).

Available options:

16,

24,

30

renderVoiceConversionEnabled

boolean

default:true

Optional flag to enable CosyVoice actor voice replacement.

renderEntryWidth

enum<integer>

default:480

Optional portrait 9:16 analysis size (480 Economy, 720 Balanced).

Available options:

480,

720

accountToken

string | null

Opaque integrator brand id for this sample (scoped to your org).

Maximum string length: 128

productToken

string | null

Optional integrator catalog product id (distinct from public productUrl listing link used in Collab flows).

Maximum string length: 128

Response

Created 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

Create digital sample

Authorizations

Body

Response