Skip to article
Documentation

Search documentation

Search stays in this browser. Queries are not sent or saved. Do not paste credentials.

Loading the public search index…

Tab or arrow keys to navigate · Enter to open · Esc to close
Browse documentation

Retry the retained animation export

Source-generated POST /animations/{animation_id}/retry-export reference: authentication, fields, responses, errors, and operational safeguards.

Public betaAPI v1 · 1.5.0Last verified
On this page

Operation

POST /animations/{animation_id}/retry-export

operationId: retry_one_click_animation_export_v1_animations__animation_id__retry_export_post

Resume an owned animation whose generated video was retained but export creation was blocked by storage quota. Free space or upgrade first. Follow error.details.recovery when offered. Reuses the original video and deterministic export ID without generating or charging again. Repeated calls return the same export. No request body or Idempotency-Key is needed. 202 means exporting; poll the original animation ID. Cancelled, refunded, deleted-source and other failures cannot use this operation.

Authentication and side effects

Use a server-side Bearer API key. Required scope: animations:write

This operation does not start paid generation. Other state changes are described above.

Parameters

Parameter Location Type Required Constraints / default Meaning
animation_id path string Yes format: uuid Owned public resource UUID; task, asset, and file IDs are not interchangeable.

Responses

HTTP Body Meaning
200 TaskResponse Current terminal animation result; inspect status and error.
202 TaskResponse Export resumed; poll the original animation ID. No additional generation or charge.
400 APIErrorEnvelope Invalid input; correct the request before retrying.
401 APIErrorEnvelope Missing, expired, or revoked API key.
403 APIErrorEnvelope Account eligibility, account status, or key scope does not allow this operation.
404 APIErrorEnvelope Resource is unavailable, not owned, or its signature is invalid/expired.
409 APIErrorEnvelope This animation cannot resume its export.
413 APIErrorEnvelope Request or decoded image exceeds the configured limit.
429 APIErrorEnvelope Account-wide rate or queue limit; wait for Retry-After.
500 APIErrorEnvelope Internal failure; preserve the task/key and retry only when marked retryable.
503 APIErrorEnvelope Service/provider unavailable; retry only when error.retryable is true.

Response headers

HTTP Header Type Meaning
200 Retry-After integer Suggested wait in seconds; respect the server value and an overall deadline.
202 Retry-After integer Suggested wait in seconds; respect the server value and an overall deadline.
429 Retry-After integer Suggested wait in seconds; respect the server value and an overall deadline.
503 Retry-After integer Suggested wait in seconds; respect the server value and an overall deadline.

Response example

json
{
  "created_at": "2026-08-30T00:00:00Z",
  "credits": {
    "charged": 1,
    "held": 0,
    "quoted": 1
  },
  "error": null,
  "finished_at": "2026-08-30T00:00:00Z",
  "id": "00000000-0000-4000-8000-000000000002",
  "metadata": {},
  "normalized_input": {},
  "object": "animation",
  "outputs": [
    {
      "byte_size": 1024,
      "created_at": "2026-08-30T00:00:00Z",
      "download_expires_at": "2026-08-30T01:00:00Z",
      "download_url": "https://downloads.example.invalid/illustrative-asset",
      "format": "clip_video",
      "id": "00000000-0000-4000-8000-000000000003",
      "media": {
        "duration_seconds": 5.04,
        "fps": 25,
        "frame_count": 126,
        "height": 512,
        "width": 512
      },
      "mime_type": "video/mp4",
      "object": "asset"
    },
    {
      "byte_size": 1024,
      "created_at": "2026-08-30T00:00:00Z",
      "download_expires_at": "2026-08-30T01:00:00Z",
      "download_url": "https://downloads.example.invalid/illustrative-export",
      "format": "frames_zip",
      "id": "00000000-0000-4000-8000-000000000006",
      "mime_type": "application/zip",
      "object": "asset"
    }
  ],
  "progress": 1,
  "stage": "completed",
  "started_at": null,
  "status": "succeeded"
}

Polling and downloads · Errors and safe retries

Was this page helpful?

No search queries, code, or free text are collected. This switch controls documentation interactions only; general site analytics follow the privacy policy. Privacy policy

Need a hand? Contact support