REST API

API Documentation

Integrate Rolo's AI video generation into your own applications. All endpoints require API key authentication.

Authentication

Bearer token via API key from Settings → API

HTTPS Only

All requests must use HTTPS

Base URL

https://app.roloads.com/api

Authentication

curl -X POST https://app.roloads.com/api/generate/avatar \
  -H "Authorization: Bearer rolo_sk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"actorId": "actor_123", "voiceId": "voice_456", "script": "Hello, world!"}'

Generate your API key in Settings → API Keys.

Endpoints

POST/api/generate/avatar1 credit

Generate an AI avatar UGC video from a script and actor/voice IDs.

Parameters

Name	Type	Description
`actorId`	`string`	ID of the avatar actor
`voiceId`	`string`	ID of the TTS voice
`script`	`string`	The spoken script (max 500 chars)

POST/api/generate/conversation2 credits

Generate a two-actor scripted dialogue video.

Parameters

Name	Type	Description
`dialogue`	`DialogueLine[]`	Array of {speaker, text} objects (2–40 lines)
`actor1Id`	`string`	ID of the first actor
`voice1Id`	`string`	Voice ID for actor 1
`actor2Id`	`string`	ID of the second actor
`voice2Id`	`string`	Voice ID for actor 2
`layout`	`string`	"cut-style" \| "side-by-side" \| "pip" (default: cut-style)

POST/api/generate/text-to-video0.5 credits

Generate a video from a text prompt.

Parameters

Name	Type	Description
`prompt`	`string`	Scene description (max 2000 chars)
`model`	`string`	Model ID (optional)
`aspectRatio`	`string`	"16:9" \| "9:16" \| "1:1" (optional)

GET/api/videos/:idFree

Retrieve the status and result of a video generation job.

Parameters

Name	Type	Description
`id`	`string`	Video job ID returned from a generate endpoint

GET/api/actorsFree

List all available actors in the library.

GET/api/voicesFree

List all available TTS voices.

Response Format

All generate endpoints return a job ID. Poll /api/videos/:id to check completion.

// Generate response
{
  "success": true,
  "jobId": "vid_abc123",
  "message": "Video generation started. It will appear in your assets when complete."
}

// Status response (GET /api/videos/:id)
{
  "id": "vid_abc123",
  "status": "completed",   // pending | processing | completed | failed
  "url": "https://cdn.roloads.com/videos/vid_abc123.mp4",
  "duration": 12.4,
  "credits_used": 1
}

Rate Limits & Usage

• Rate limit: 60 requests per minute per API key
• Concurrent jobs: Up to 5 simultaneous generation jobs
• Credit deduction: Credits are deducted immediately on job creation
• Refunds: Credits automatically refunded if generation fails

Need higher limits? Contact us for enterprise pricing.