JARAI Developers

Getting Started

This guide walks you through registering as a JARAI partner, obtaining your API key, triggering your first production, polling for status, and downloading the finished deliverables.

1. Register as a Partner

Submit a registration request with your organisation details. No API key is required for this step.

curl -X POST https://apim-jarai-prd.azure-api.net/v1/partners/register \
-H "Content-Type: application/json" \
-d '{
  "organisationName": "Acme Media Ltd",
  "contactEmail": "api@acme-media.com",
  "contactName": "Jane Smith"
}'

The API returns 202 Accepted with your partnerId. A verification email is sent to the contact email address.

2. Verify Your Email

Click the verification link in the email, or call the verify endpoint directly with the token from the link:

curl "https://apim-jarai-prd.azure-api.net/v1/partners/verify?token=YOUR_JWT_TOKEN"

The response contains your API key in the format jarai_{base64url}. Store this key securely — it is shown only once and cannot be retrieved again.

3. Explore Your Accounts

List the accounts available to your partner key:

curl https://apim-jarai-prd.azure-api.net/v1/accounts \
-H "X-API-Key: jarai_your_api_key_here"

Each account includes its accountId, available avatars, and connected platforms.

4. Trigger Your First Production

Use the accountId from the previous step along with valid languageId, countryId, and avatarId:

curl -X POST https://apim-jarai-prd.azure-api.net/v1/accounts/{accountId}/productions \
-H "X-API-Key: jarai_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
  "topic": "Quarterly earnings highlights for Q1 2026",
  "languageId": "LANGUAGE_UUID",
  "countryId": "COUNTRY_UUID",
  "avatarId": "AVATAR_UUID"
}'

The API returns 202 Accepted with a productionId and a Location header pointing to the status endpoint.

Optional Fields

FieldTypeDescription
projectTypeSlugstringProject type identifier (e.g. social-video-30s). Defaults to the account’s default project type.
metadataMDstringMarkdown metadata for the production (max 4,096 characters). Passed to the AI pipeline as additional context.

5. Poll for Status

Check the production status using the productionId:

curl https://apim-jarai-prd.azure-api.net/v1/productions/{productionId} \
-H "X-API-Key: jarai_your_api_key_here"

Recommended polling intervals:

  • While Queued: every 10 seconds
  • While Producing: every 30 seconds
  • Once terminal (Published, Failed, Cancelled): stop polling

For real-time updates without polling, see Webhook Integration.

6. Download Deliverables

Once the production reaches AwaitingApproval, Distributing, or Published status, retrieve the deliverable files:

curl https://apim-jarai-prd.azure-api.net/v1/productions/{productionId}/deliverables \
-H "X-API-Key: jarai_your_api_key_here"

Each deliverable includes a time-limited sasUrl (valid for 1 hour) for direct download. Deliverable types include Video, ClosedCaptions, AudioDescription, Transcript, and ComplianceCertificate.

Next Steps