Rivya AI Docs

Grok Imagine Video API Integration

Use Grok Imagine Video through Rivya Public API v1 with model id grok-imagine-video, supported inputs, parameters, Files API rules, credits, and response examples.

Available via APIText or URL ready; reference modes use Files APIVideo
API model id

grok-imagine-video

Inputs

text, file

Files API

Required for reference modes

Base credits

10

Capability

Video

Billing

FIXED

Prompt limit

5000 characters

Request contract

Send the model id at the top level. Model-specific controls belong in params.

KeyTypeRequiredDefaultDescription
modelstringYesgrok-imagine-videoUse the grok-imagine-video API model id.
promptstringYes-Maximum 5000 characters for this model.
paramsobjectNo-Model-specific parameter object. Use the rows below for allowed keys.
client_request_idstringNo-Optional client-side id for tracing requests in your system.

Model parameters

KeyTypeRequiredDefaultRangeOptionsDescription
modeselectNonormal-fun, normal, spicyGeneration mode
durationnumberNo6min 6 / max 30 / step 1-Duration
resolutionselectNo480p-480p, 720pResolution
aspect_ratioselectNo2:3-1:1, 16:9, 9:16, 2:3, 3:2Aspect ratio

Upload policy

Upload reference files first, then place the returned URL and duration token inside params.referenceMediaItems.

Reference rule

Reference image: Upload up to 1 image file for image projects.

Max files

1

Accepted file kinds

image

Duration token

Video and audio references should carry durationToken from /api/v1/files when duration verification is required.

kindMax sizeMIME types
image10 MBimage/jpeg, image/png, image/webp

Minimal request

{
  "model": "grok-imagine-video",
  "prompt": "A cinematic product reveal with smooth camera movement",
  "params": {
    "mode": "normal",
    "duration": 6,
    "resolution": "480p",
    "aspect_ratio": "2:3"
  }
}

Reference-file request

{
  "model": "grok-imagine-video",
  "prompt": "A cinematic product reveal with smooth camera movement",
  "params": {
    "mode": "normal",
    "duration": 6,
    "resolution": "480p",
    "aspect_ratio": "2:3",
    "referenceMediaItems": [
      {
        "url": "https://cdn.example.com/reference-image.png",
        "kind": "image",
        "name": "reference-image.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Create response

The create endpoint returns a public task id. Poll the status endpoint until the task succeeds or fails.

{
  "id": "task_grok_imagine_video_example",
  "status": "queued",
  "model": "grok-imagine-video",
  "reserved_credits": 10,
  "final_credits": 0,
  "created_at": "2026-05-11T00:00:00.000Z",
  "updated_at": "2026-05-11T00:00:00.000Z",
  "result": null,
  "error": null
}

Common errors

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

Some modes require Files API reference uploads.