> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yourproducthere.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Programmatic access to Digital Samples, Actors, Insta Swaps, and webhooks on Your Product Here.

The YPH Public API lets your systems create **Digital Samples**, manage **Actors**, queue **Insta Swaps**, and receive **webhooks** — without using the Collab UI.

<Info>
  **Integrating with AI?** If you are using ChatGPT, Claude, GitHub Copilot, Cursor, or any other AI assistant to build your integration, just feed them our [**AI Integration Skills Context (`/llms.txt`)**](/llms.txt) file. This gives the AI the exact API specifications, strict parameters, validation limits, and step-by-step workflow requirements so it can write your integration code instantly and accurately.
</Info>

## Base URLs

| Environment | Base URL                            |
| ----------- | ----------------------------------- |
| Production  | `https://api.yourproducthere.ai/v1` |

Your base API origin is managed and provided by YPH. After activation, your org's base URL and curl examples appear on the in-app **Developer** page.

## What you can build

* Sync actors and digital samples from your PIM or DAM
* Upload seed videos via presigned URLs or direct HTTP/HTTPS links (automatic secure R2 stream-ingest)
* Queue face-replacement renders and poll for results
* Subscribe to `insta_swap.*` events instead of email

## What is not in scope (today)

* Collab, marketplace, or proof-of-post flows
* Self-serve account creation (`POST /v1/accounts`)
* Email notifications for API-enabled orgs (use webhooks)

## Getting access

The YPH Public API is restricted to approved enterprise integration partners. Programmatic access is locked by default — you cannot self-serve API keys.

<Warning>
  **Request API activation** — contact Michel at [michel@yourproducthere.ai](mailto:michel@yourproducthere.ai) to enable API access for your organization and configure your API domain.
</Warning>

Once your organization has been approved and activated:

1. Sign in to [Your Product Here](https://yourproducthere.ai).
2. Open the **Developer** page in your sidebar.
3. Generate your API key (`yph_sk_live_…`).

<Note>
  API keys are shown in full only once at creation/regeneration. Store them securely in your secrets manager.
</Note>

## Next steps

<CardGroup cols={2}>
  <Card title="Enterprise installation" icon="building" href="https://docs.yourproducthere.ai/guides/enterprise-installation">
    Onboarding, beta asset rules, and quality checklist.
  </Card>

  <Card title="Quickstart" icon="rocket" href="https://docs.yourproducthere.ai/quickstart">
    Health check, account, and first authenticated call.
  </Card>

  <Card title="Authentication" icon="key" href="https://docs.yourproducthere.ai/authentication">
    Bearer tokens and key prefixes.
  </Card>

  <Card title="Webhooks" icon="webhook" href="https://docs.yourproducthere.ai/webhooks">
    Signed events and endpoint verification.
  </Card>

  <Card title="API Reference" icon="code" href="https://docs.yourproducthere.ai/api-reference">
    OpenAPI-generated endpoint docs.
  </Card>
</CardGroup>