Developer documentation

Create an asynchronous AI video job

Verified Business accounts can create AI video through the same protected license, credit, status, and webhook model used by TryRobe image workflows. Provider identities and credentials remain private implementation details.

Quote before creation

POST /v1/videos/quote returns the exact Business credit requirement and localized estimate for a quality, supported duration, audio choice, and optional scene-image stage. A quote does not reserve credits.

Submit from your backend

POST /v1/videos accepts public HTTPS source_image_url and optional product_image_url values. Include kind, quality, prompt, aspect_ratio, duration_seconds, audio_enabled, create_scene_image, and a unique Idempotency-Key.

POST https://api.tryrobe.in/v1/videos
Authorization: Bearer tr_live_REPLACE_WITH_YOUR_KEY
Idempotency-Key: video-action-unique-id

{
  "kind": "ugc",
  "quality": "balanced",
  "prompt": "Natural creator-style product demonstration in warm daylight",
  "source_image_url": "https://merchant.example/creator.jpg",
  "product_image_url": "https://merchant.example/product.jpg",
  "aspect_ratio": "9:16",
  "duration_seconds": 8,
  "audio_enabled": true,
  "create_scene_image": true
}

Reliable completion

Persist the returned job_id. Poll GET /v1/videos/:jobId or process signed video.succeeded and video.failed webhooks. GET /v1/videos/recover with the original Idempotency-Key recovers an accepted job after an uncertain network response.

Credit and media lifecycle

Credits are reserved atomically on acceptance and captured only after the final MP4 is securely stored. The complete reservation is returned after terminal failure or timeout. Protected video output is temporary and normally available for seven days.

Frequently asked questions

Can a browser or mobile app call the video API directly?

No. Keep the Business license on a trusted backend and expose only your own authenticated client endpoint.

What does create_scene_image do?

It creates a polished opening scene from the references before animating it. The quote includes a discounted scene-image stage and the complete pipeline remains one atomic customer job.