API Reference
Request and response contracts for the Indream HTTP API.
Base URL: https://api.indream.ai. Authenticate with Authorization: Bearer <YOUR_API_KEY>.
Endpoint pages describe request fields, response bodies, and errors from the current OpenAPI specification. Most requests use JSON. Uploads send raw file bytes.
Resources
| Resource | Operations |
|---|---|
| Projects | Create, list, get, update metadata, sync state, delete. |
| Uploads | Upload a file. |
| Assets | Get, delete, list project assets, bind, unbind. |
| Exports | Create from state, create from a project, list, get, cancel. |
| Editor | Capabilities, validate state. |
| Illustrations | Search. |
Try a request
Enter an API key in an endpoint's playground to send a real request. Requests use the key's workspace and can create resources or consume credits. Clear the entered credentials on shared computers.
The upload endpoint is documented without an interactive submit control. Use the cURL and SDK upload examples to send file bytes with the required headers.
Read responses
Successful JSON responses wrap the result in data and request or pagination information in meta. List responses use meta.nextPageCursor; pass it as pageCursor for the next page. SDK resource methods unwrap these responses for you.
Failed requests use problem fields including status, detail, and errorCode. Some successful operations have a separate result to inspect, such as valid from editor validation or status from an export task. See Errors and retries.
Related guides
Use the Quick Start for your first export, Editor state to author a video, and Billing and limits to understand workspace credits and output limits.
Last updated on