Skip to main content
GET
/
v1
/
tasks
List tasks
curl --request GET \
  --url https://api.framelane.io/v1/tasks \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "render_01J8QR2K5VKDGN2T4FBM3CZYX7",
      "kind": "render",
      "workspace_id": "ws_01J8QR2K5VKDGN2T4FBM3CZYX8",
      "status": "queued",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "task_type": "transcribe",
      "progress_percent": 0,
      "progress_stage": "compositing",
      "output": {
        "url": "https://cdn-user.framelane.io/render_01J.../output.mp4",
        "width": 1920,
        "height": 1080,
        "duration": 15.3,
        "size_bytes": 12582912
      },
      "error": {
        "code": "invalid_source",
        "message": "Source URL returned 404."
      },
      "metadata": {
        "project_id": "proj_123",
        "user_ref": "usr_abc"
      },
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>",
  "has_more": false
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
type
enum<string> | null

The 4 task types exposed by the public API.

Renderer tasks (remove_background, gaze_redirect, super_resolution) are dispatched via the Redis broker; transcribe is dispatched via AssemblyAI.

Values:

  • remove_background — AI background removal — outputs media with a transparent background.
  • gaze_redirect — AI gaze redirection — adjusts on-screen eyes to face the camera.
  • super_resolution — AI upscaling — increases resolution by a 1–4× factor.
  • transcribe — Speech-to-text transcription (via AssemblyAI) with optional analysis.
Available options:
remove_background,
gaze_redirect,
super_resolution,
transcribe
​
status
enum<string> | null

Values:

  • ingesting — External source files are being copied into Framelane storage.
  • queued — Accepted and waiting for a worker to pick it up.
  • processing — Actively rendering or processing.
  • completed — Finished successfully; the output artifact is available.
  • failed — Terminated with an error (see error).
  • cancelled — Cancelled by the caller before completion.
Available options:
ingesting,
queued,
processing,
completed,
failed,
cancelled
​
limit
integer
default:20
Required range: 1 <= x <= 200
​
cursor
string | null

Response

Successful Response

​
data
JobOut · object[]
required
​
next_cursor
string | null
​
has_more
boolean
default:false