Get digital sample

curl --request GET \
  --url https://api.yourproducthere.ai/v1/digital-samples/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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"
  }
}

GET

digital-samples

{id}

Get digital sample

curl --request GET \
  --url https://api.yourproducthere.ai/v1/digital-samples/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

Response

Sample details

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

Get digital sample

Authorizations

Path Parameters

Response