tasks

List tasks

Returns a cursor-paginated list of tasks for the workspace. Filter by type or status.

get/v1/tasks

Request

  • Base URL: https://api.framelane.io
  • URL: https://api.framelane.io/v1/tasks
  • Auth: HTTP bearer

Query parameters

type'transcribe'

The AI task types the API offers.

Values:

  • transcribe — Speech-to-text transcription (via AssemblyAI) with optional analysis. Returns the transcript inline on the task's result object — there is no file artifact, so output is null and /v1/tasks/{id}/download returns 404.
status'ingesting' | 'queued' | 'processing' | 'completed' | 'failed' | 'cancelled'

Values:

  • ingesting — External source files are being probed for duration before the render is queued.
  • 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.
limitinteger
cursorstring nullable

Response

Successful Response

next_cursorstring nullable
has_moreboolean

Example response

{
  "data": [
    {
      "id": "render_01J8QR2K5VKDGN2T4FBM3CZYX7",
      "workspace_id": "ws_01J8QR2K5VKDGN2T4FBM3CZYX8",
      "output": {
        "url": "https://cdn-user.framelane.io/render_01J.../output.mp4",
        "width": 1920,
        "height": 1080,
        "duration": 15.3,
        "size_bytes": 12582912
      },
      "result": {
        "language_code": "en",
        "text": "Welcome back to the show."
      },
      "error": {
        "message": "Source URL returned 404."
      },
      "metadata": {
        "project_id": "proj_123",
        "user_ref": "usr_abc"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.