Developer documentation

Integrate an engine from purchase to production.

This documentation covers the complete UrTheProduct customer API: key handling, request construction, direct uploads, synchronous results, asynchronous video jobs, quota behavior, failures, retries, and framework integrations.

The key is a package credential, not a general AI key. It works only for the purchased operation and locked configuration. Provider names, models, credentials, costs, and internal prompts are intentionally outside the public contract.

Production base URL

https://urtheproduct.com

Set URTHEPRODUCT_BASE_URL=https://urtheproduct.com in your server environment. Do not add tracking parameters to API URLs. All examples use environment variables and never hard-code a customer key.

Complete integration lifecycle

Choose an engine

Read its package, locked configuration, input schema, unit type, expiration, rate limit, and usage restrictions.

Purchase and reveal

Complete Whop checkout, wait for verified fulfillment, copy the key during its protected ten-minute reveal, and confirm that it is saved.

Store server-side

Create URTHEPRODUCT_API_KEY in your backend or deployment environment. Never place it in a public environment variable or browser bundle.

Send one strict request

Call the route purchased by that key with bearer authentication, JSON content type, and one idempotency key per logical operation.

Handle the result

Use the normalized response, preserve request_id on errors, poll asynchronous jobs, and refresh expiring signed output URLs when required.

Headers required on generation requests

Header	Value	Purpose
`Authorization`	`Bearer $URTHEPRODUCT_API_KEY`	Authenticates the package and enforces its operation, quota, expiration, rate, and locked settings.
`Idempotency-Key`	8–128 safe characters	Identifies one logical POST so network retries cannot duplicate provider work or quota charging.
`Content-Type`	`application/json`	Required for every POST body. Unknown JSON properties are rejected.
`X-Request-Id`	Optional 8–80 character identifier	Lets your backend correlate a request. The API generates one when omitted.

Choose the next page

QuickstartMake the first request in cURL, JavaScript, or Python.AuthenticationStore, use, rotate, and revoke a key safely.Private uploadsSend image, audio, and video inputs without proxying large files through your app.Errors and retriesKnow exactly when a retry is safe and whether quota is affected.

Machine-readable contract

The OpenAPI 3.1 document is generated from the same strict request schemas used by the routes. Use it for inspection or client generation, but keep runtime validation and error handling in your integration.