API Reference

Use the interactive reference in this section to understand endpoints, parameters, request formats, and responses for the Indream Open API.

Base URL and Auth

• Base URL: https://api.indream.ai
• Auth header: x-api-key: <YOUR_API_KEY>
• Each endpoint page includes a manual API key input for the interactive playground, stored only in your browser
• Most endpoints use application/json
• POST /v1/uploads sends file bytes as the raw request body

Endpoints

Projects

• POST /v1/projects: create a project
• GET /v1/projects: list project summaries
• GET /v1/projects/{projectId}: fetch project detail with editorState
• PATCH /v1/projects/{projectId}: update project metadata
• POST /v1/projects/{projectId}/sync: replace persisted editorState
• DELETE /v1/projects/{projectId}: delete a project
• POST /v1/projects/{projectId}/exports: export the latest saved project

Uploads And Assets

• POST /v1/uploads: upload a file and create an asset
• GET /v1/assets/{assetId}: fetch asset detail
• DELETE /v1/assets/{assetId}: delete asset after reference checks
• GET /v1/projects/{projectId}/assets: list one project's assets
• POST /v1/projects/{projectId}/assets: bind an existing asset to a project
• DELETE /v1/projects/{projectId}/assets/{assetId}: remove project binding only

Exports

• POST /v1/exports: create a stateless export task
• GET /v1/exports: list export tasks
• GET /v1/exports/{taskId}: get a task

Editor

• GET /v1/editor/capabilities: fetch supported editor abilities
• POST /v1/editor/validate: validate editor JSON before create or sync

Important Runtime Behavior

• Project, upload, asset, and export routes require eligible OpenAPI access.
• If access is not available for the current account, these routes return 403 OPEN_API_RUNTIME_ACCESS_FORBIDDEN.
• Export create enforces per-user active concurrency:
  • max 2 active tasks (PENDING / PROCESSING / PAUSED)
  • over limit returns 422 OPEN_API_EXPORT_CONCURRENCY_LIMIT_EXCEEDED
• Export tasks are asynchronous; use polling or webhook callbacks.
• outputUrl is temporary, so persist files to your own storage promptly.

Error Shape

Errors follow stable problem-details fields:

• type
• title
• status
• detail
• errorCode