Quickstart

Prerequisites

API Access is Locked
programmatic access is locked by default. Before you can make any authenticated calls, you must contact Michel ([email protected]) to enable API access for your organization.

API access enabled for your organization (by contacting Michel)
An API key from Developer in the app (yph_sk_live_…)
Your environment base URL (see Introduction)

Building with an AI Copilot? You can copy our AI Integration Skills Context (/llms.txt) and paste it directly into your AI prompt (or attach it as a file). It is fully optimized to tell LLMs exactly how our video upload, actor creation, and Insta Swap rendering flows operate.

Replace BASE_URL and YOUR_API_KEY in the examples below.

1. Health check (no auth)

curl -s "$BASE_URL/health"

Expected response:

{
  "ok": true,
  "service": "yph-api",
  "env": "production"
}

2. Account and credits

curl -s "$BASE_URL/account" \
  -H "Authorization: Bearer YOUR_API_KEY"

Expected response:

{
  "orgId": "…",
  "creditBalance": 10,
  "apiAccessEnabled": true
}

3. List actors

curl -s "$BASE_URL/actors" \
  -H "Authorization: Bearer YOUR_API_KEY"

Typical integration flow

Create a Digital Sample

POST /digital-samples with title and render prompts.

Upload seed video

POST /digital-samples/{id}/seed/upload-url → PUT file to presigned URL → POST …/seed/register (automatically validates, approves, and activates the sample).

Create an Actor

Upload face/body/voice assets via your app workflow or presigned URLs, then POST /actors.

Queue Insta Swap

POST /digital-samples/{id}/insta-swaps with actorId. Render starts automatically; credits are charged.

Poll or webhook

GET /insta-swaps/{id} until status is terminal, or handle insta_swap.completed / insta_swap.failed webhooks.

See End-to-end workflow for detail.

Errors

HTTP	Meaning
`401`	Missing or invalid API key
`403`	`api_access_disabled` for the org
`402`	`insufficient_credits` on insta-swap
`404`	Resource not found or wrong org
`422`	Webhook URL failed verification

Get started

Integrations

AI Integrators

Prerequisites

1. Health check (no auth)

2. Account and credits

3. List actors

Typical integration flow

Errors

​Prerequisites

​1. Health check (no auth)

​2. Account and credits

​3. List actors

​Typical integration flow

​Errors

Prerequisites

1. Health check (no auth)

2. Account and credits

3. List actors

Typical integration flow

Errors