Update actor
Update the attributes or asset URLs of an existing actor. All fields in the body are optional.
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).
