API reference / Renders & exports

Get video export progress

GET/api/v1/promovideo/export

Authorization

Send your API key or MCP OAuth token in the Authorization: Bearer header. Active or trialing Unlimited is required.

Required permission exports:read

Parameters

jobIdqueryrequired

string · uuid

Persistent jobId returned by POST /promovideo/export; bucketName is not needed. Prefer its statusUrl.

Request example

Set ALF_API_URL to https://dashboard.applaunchflow.com/api/v1 and ALF_API_KEY to your key. Replace sample IDs with your project’s values.

cURL

curl --request GET \
  --url "$ALF_API_URL/promovideo/export?jobId=11111111-1111-4111-8111-111111111111" \
  --header "Authorization: Bearer $ALF_API_KEY"

Response

Successful JSON responses wrap the result in data, with a request ID in meta.requestId.

exportdatarequired

object

downloadUrldataoptional

string

rendersdataoptional

object[]

filesdataoptional

object[]

View response schema

{
  "type": "object",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "export": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "format": "uuid",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
            },
            "contentType": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "queued",
                "rendering",
                "bundling",
                "completed",
                "failed",
                "cancelled"
              ]
            },
            "progress": {
              "type": "number"
            },
            "format": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "contentType",
            "status",
            "progress",
            "format"
          ],
          "additionalProperties": {}
        },
        "downloadUrl": {
          "type": "string"
        },
        "renders": {
          "type": "array",
          "items": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          }
        },
        "files": {
          "type": "array",
          "items": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          }
        }
      },
      "required": [
        "export"
      ]
    },
    "meta": {
      "type": "object",
      "required": [
        "requestId"
      ],
      "properties": {
        "requestId": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

Errors & retries

Errors use application/problem+json. Check the stable code and keep requestId when contacting support. Respect Retry-After on 429 responses.

See error handling and idempotency →