Docs
Api referenceExports

Create export task from project

Create a cloud export task from the latest persisted project state. `Idempotency-Key` is optional. If header is omitted but `clientTaskId` is provided, task deduplication uses `clientTaskId`. The created task may include `projectId` for downstream tracking, webhook correlation, and task listing.

POST
/v1/projects/{projectId}/exports

Create a cloud export task from the latest persisted project state. Idempotency-Key is optional. If header is omitted but clientTaskId is provided, task deduplication uses clientTaskId. The created task may include projectId for downstream tracking, webhook correlation, and task listing.

Authorization

ApiKeyAuth
x-api-key<token>

Enter your API key manually in the interactive docs playground. The value is stored only in the current browser and is not injected from server environment variables.

In: header

Path Parameters

projectId*string
Formatuuid

Header Parameters

Idempotency-Key?string

Optional idempotency key for create/finalize style POST requests. When provided, the server replays the first completed response for the same request payload.

Request Body

application/json

clientTaskId?string
Lengthlength <= 128
fps*integer
Value in30 | 60
ratio*string
Value in"16:9" | "9:16" | "1:1" | "4:3" | "3:4" | "custom"
scale*number
Range0.6 <= value <= 8
format*string
Value in"mp4" | "webm"
callbackUrl?string
Lengthlength <= 1024
callbackHeaders?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.indream.ai/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/exports" \  -H "Content-Type: application/json" \  -d '{    "fps": 30,    "ratio": "16:9",    "scale": 0.6,    "format": "mp4"  }'
{
  "data": {
    "taskId": "string",
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "createdAt": "2019-08-24T14:15:22Z",
    "durationSeconds": 0,
    "billedStandardSeconds": 0,
    "chargedCredits": "string",
    "chargedCreditPool": "string"
  },
  "meta": {}
}
{
  "type": "FORBIDDEN",
  "title": "Forbidden",
  "status": 403,
  "detail": "The current account is not eligible for this Open API route",
  "errorCode": "OPEN_API_RUNTIME_ACCESS_FORBIDDEN"
}
{
  "type": "FORBIDDEN",
  "title": "Forbidden",
  "status": 403,
  "detail": "The current account is not eligible for this Open API route",
  "errorCode": "OPEN_API_RUNTIME_ACCESS_FORBIDDEN"
}
{
  "type": "FORBIDDEN",
  "title": "Forbidden",
  "status": 403,
  "detail": "The current account is not eligible for this Open API route",
  "errorCode": "OPEN_API_RUNTIME_ACCESS_FORBIDDEN"
}
{
  "type": "FORBIDDEN",
  "title": "Forbidden",
  "status": 403,
  "detail": "The current account is not eligible for this Open API route",
  "errorCode": "OPEN_API_RUNTIME_ACCESS_FORBIDDEN"
}
{
  "type": "FORBIDDEN",
  "title": "Forbidden",
  "status": 403,
  "detail": "The current account is not eligible for this Open API route",
  "errorCode": "OPEN_API_RUNTIME_ACCESS_FORBIDDEN"
}