curl --request PATCH \
--url https://api.yourproducthere.ai/v1/actors/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"faceAssetUrl": "<string>",
"bodyAssetUrl": "<string>",
"voiceClipUrl": "<string>",
"accountToken": "<string>"
}
'import requests
url = "https://api.yourproducthere.ai/v1/actors/{id}"
payload = {
"displayName": "<string>",
"faceAssetUrl": "<string>",
"bodyAssetUrl": "<string>",
"voiceClipUrl": "<string>",
"accountToken": "<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({
displayName: '<string>',
faceAssetUrl: '<string>',
bodyAssetUrl: '<string>',
voiceClipUrl: '<string>',
accountToken: '<string>'
})
};
fetch('https://api.yourproducthere.ai/v1/actors/{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/actors/{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([
'displayName' => '<string>',
'faceAssetUrl' => '<string>',
'bodyAssetUrl' => '<string>',
'voiceClipUrl' => '<string>',
'accountToken' => '<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/actors/{id}"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"faceAssetUrl\": \"<string>\",\n \"bodyAssetUrl\": \"<string>\",\n \"voiceClipUrl\": \"<string>\",\n \"accountToken\": \"<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/actors/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"faceAssetUrl\": \"<string>\",\n \"bodyAssetUrl\": \"<string>\",\n \"voiceClipUrl\": \"<string>\",\n \"accountToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yourproducthere.ai/v1/actors/{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 \"displayName\": \"<string>\",\n \"faceAssetUrl\": \"<string>\",\n \"bodyAssetUrl\": \"<string>\",\n \"voiceClipUrl\": \"<string>\",\n \"accountToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "a1c02874-e339-4d11-8fa1-e6a2bc38c41d",
"displayName": "Corporate Professional",
"accountToken": "creator_42",
"faceAssetUrl": "https://cdn.example.com/actors/face.jpg",
"bodyAssetUrl": "https://cdn.example.com/actors/body.jpg",
"voiceClipUrl": "https://cdn.example.com/actors/voice.mp3",
"signedFaceAssetUrl": "https://account.r2.cloudflarestorage.com/bucket/identity-assets/face.png?X-Amz-Signature=...",
"signedBodyAssetUrl": "https://account.r2.cloudflarestorage.com/bucket/identity-assets/body.png?X-Amz-Signature=...",
"signedVoiceClipUrl": "https://account.r2.cloudflarestorage.com/bucket/identity-assets/voice.mp3?X-Amz-Signature=...",
"identityPrepStatus": "pending",
"identityPrepReadyAt": null,
"warnings": [
"faceAssetUrl: image dimensions below recommended 480x832"
],
"createdAt": "2026-06-20T12:00:00Z",
"updatedAt": "2026-06-20T12:05:00Z"
}Update actor
Update the attributes or asset URLs of an existing actor. All fields in the body are optional.
curl --request PATCH \
--url https://api.yourproducthere.ai/v1/actors/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayName": "<string>",
"faceAssetUrl": "<string>",
"bodyAssetUrl": "<string>",
"voiceClipUrl": "<string>",
"accountToken": "<string>"
}
'import requests
url = "https://api.yourproducthere.ai/v1/actors/{id}"
payload = {
"displayName": "<string>",
"faceAssetUrl": "<string>",
"bodyAssetUrl": "<string>",
"voiceClipUrl": "<string>",
"accountToken": "<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({
displayName: '<string>',
faceAssetUrl: '<string>',
bodyAssetUrl: '<string>',
voiceClipUrl: '<string>',
accountToken: '<string>'
})
};
fetch('https://api.yourproducthere.ai/v1/actors/{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/actors/{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([
'displayName' => '<string>',
'faceAssetUrl' => '<string>',
'bodyAssetUrl' => '<string>',
'voiceClipUrl' => '<string>',
'accountToken' => '<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/actors/{id}"
payload := strings.NewReader("{\n \"displayName\": \"<string>\",\n \"faceAssetUrl\": \"<string>\",\n \"bodyAssetUrl\": \"<string>\",\n \"voiceClipUrl\": \"<string>\",\n \"accountToken\": \"<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/actors/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"<string>\",\n \"faceAssetUrl\": \"<string>\",\n \"bodyAssetUrl\": \"<string>\",\n \"voiceClipUrl\": \"<string>\",\n \"accountToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yourproducthere.ai/v1/actors/{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 \"displayName\": \"<string>\",\n \"faceAssetUrl\": \"<string>\",\n \"bodyAssetUrl\": \"<string>\",\n \"voiceClipUrl\": \"<string>\",\n \"accountToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "a1c02874-e339-4d11-8fa1-e6a2bc38c41d",
"displayName": "Corporate Professional",
"accountToken": "creator_42",
"faceAssetUrl": "https://cdn.example.com/actors/face.jpg",
"bodyAssetUrl": "https://cdn.example.com/actors/body.jpg",
"voiceClipUrl": "https://cdn.example.com/actors/voice.mp3",
"signedFaceAssetUrl": "https://account.r2.cloudflarestorage.com/bucket/identity-assets/face.png?X-Amz-Signature=...",
"signedBodyAssetUrl": "https://account.r2.cloudflarestorage.com/bucket/identity-assets/body.png?X-Amz-Signature=...",
"signedVoiceClipUrl": "https://account.r2.cloudflarestorage.com/bucket/identity-assets/voice.mp3?X-Amz-Signature=...",
"identityPrepStatus": "pending",
"identityPrepReadyAt": null,
"warnings": [
"faceAssetUrl: image dimensions below recommended 480x832"
],
"createdAt": "2026-06-20T12:00:00Z",
"updatedAt": "2026-06-20T12:05:00Z"
}Authorizations
Your organization API key starting with yph_sk_live_…
Path Parameters
Body
Optional updated display name for the actor.
80Optional updated secure face image URL (passing null clears the current face). If a new URL is provided, it is securely ingested and hosted.
Optional updated secure body asset URL (passing null clears the current body). If a new URL is provided, it is securely ingested and hosted.
Optional updated secure voice clip URL (passing null clears the current voice clip). If a new URL is provided, it is securely ingested and hosted. Must be MP3, WAV, or OGG clean speech between 10-30 seconds.
Optional updated integrator actor token (pass null to clear).
128Response
Updated successfully
Actor resource returned by GET, POST, and PATCH.
- Write-only (POST/PATCH body):
faceAssetUrl,bodyAssetUrl,voiceClipUrl— your public HTTPS source URLs. YPH ingests copies into private storage. - Read-only (responses):
signedFaceAssetUrl,signedBodyAssetUrl,signedVoiceClipUrl— short-lived presigned GET URLs for preview/download. Never send these back on PATCH. - Echo (responses):
faceAssetUrl,bodyAssetUrl,voiceClipUrlrepeat the external source URLs you submitted (null if the actor was created via the YPH app upload flow). - Integrator identity:
accountTokenidentifies the creator (or the brand when producing in-house). See Integrator tokens.
80Integrator creator or brand actor id.
128Echo of your external face image HTTPS URL (write via POST/PATCH body only). Null when no external source was registered.
Echo of your external body image HTTPS URL (write via POST/PATCH body only).
Echo of your external voice clip HTTPS URL (write via POST/PATCH body only).
Short-lived presigned GET URL for the ingested face asset (typically valid ~10 minutes).
Short-lived presigned GET URL for the ingested body asset.
Short-lived presigned GET URL for the ingested voice clip.
Whether the actor has completed first-render AI identity prep (automatic photo optimization). pending until the first paid render prepares the assets, then preparing → ready. failed is non-blocking — renders still succeed with defaults. Poll this field after a PATCH that changes faceAssetUrl/bodyAssetUrl (which resets it to pending).
pending, preparing, ready, failed Timestamp when identity prep last succeeded, or null if never prepared.
Non-blocking quality hints from asset validation (e.g. recommended dimensions or audio duration).
