Overview

This site is the implementation guide for the Indream Open API.

What You Can Build

• Create export tasks from editor JSON state.
• Validate editor JSON before sending render requests.
• Poll task status until terminal states.
• Receive async notifications through callbacks.

Core Objects

• Export Task: A long-running render job created by POST /v1/exports.
• Editor State: The full scene graph and timeline payload used for rendering.
• Capabilities: The currently supported animation, caption animation, transition, effect, and preset set.

Recommended Request Flow

1. Call GET /v1/editor/capabilities and cache supported values.
2. Build editor JSON and run POST /v1/editor/validate.
3. Submit POST /v1/exports.
4. Track progress through GET /v1/exports/{taskId} or callback events.
5. Consume outputUrl when task status reaches COMPLETED.
6. outputUrl is temporary and usually expires in 1-3 days, so persist the file to your own storage as soon as possible.

Error Model

Error payloads follow a stable problem-details style:

• type: Machine-readable category.
• title: Short summary.
• status: HTTP status code.
• detail: Human-readable detail.
• errorCode: Stable business code for client logic.

You should branch retry logic by status class:

• Retry-safe: 429, 5xx
• Fix request: 400, 401, 403, 404, 422

Next Steps

• Start with Quick Start
• Review Editor JSON Guide
• Open API Reference
• Use Node.js Client or Python Client