Developer quickstart

Build on JARAI by calling the Partner API — submit productions programmatically, track them to completion, and pull the finished deliverables into your own product.

The reference lives in the Developer Portal

This page is a conceptual quickstart. The authoritative, always-current API reference — every endpoint, request/response schema, and error code — is in the Developer Portal. When this guide and the reference disagree, the reference wins.

🎬 Call the Partner API in 5 minutes

Prefer to read? Open the step-by-step transcript

1. Create a scoped API key in the Studio Console — sign in, then open Settings → API Keys.
2. Send your first authenticated request (key in the auth header).
3. Submit a production (project type + theme + options).
4. Poll its status until the deliverables are ready — or receive a webhook.
5. Fetch the deliverables.

The integration shape

JARAI productions are asynchronous: you submit a request, JARAI runs the multi-step AI pipeline (this takes minutes, not milliseconds), and the result arrives later. So every integration follows the same shape:

1. Authenticate — create a scoped key in the Studio Console (Settings → API Keys; self-serve, no approval) and send it on every request. See Authentication & API keys.

2. Submit a production — POST the request (project type, content theme, avatar(s), options). You get back an identifier and an initial status.

3. Track it — either poll the production’s status endpoint, or register a webhook and let JARAI call you when the status changes. See Production lifecycle.

4. Collect the deliverables — once the production reaches its terminal “ready” state, fetch the packaged assets (video/audio/text + attribution).

Next steps

Authentication & API keys

How to create, use, rotate and scope API keys. Read →

Production lifecycle

Submit → status states → polling vs webhooks → deliverables. Read →

Full API reference

Every endpoint + schema, live. Open the Developer Portal →

Concepts

New to JARAI? Start with What is JARAI Studio? and the glossary.

Note

Partner API usage draws on the same token allowance and billing as the Console. Watch your usage on the billing surfaces; productions that would exceed an account’s budget are rejected with a clear error rather than partially run.