List team tasks

GET/v1/video/tasks

Returns tasks across your team, including those created with other API keys.

Put your API key after Authorization: Bearer in the request header.
Lists all of your team's tasks, whichever API key created them, newest first.
Page with next_cursor; it is null on the last page.
Read usage, charges, results and errors from the task by its ID.

Headers

#AuthorizationstringRequired

Bearer, a space and your API key. A missing or invalid key returns 401 authentication_failed.

#X-Request-IDstring

Your own request identifier. An invalid or repeated value is replaced; the value used comes back in the X-Request-ID response header.

Query parameters

#cursorstring

Use next_cursor from the preceding page. A value not issued for this team's task list returns invalid_request.

Length1–256

#page_sizeinteger

Maximum number of tasks to return on this page.

Default50Range1–100

Request

curl --request GET "${CHENVOYA_BASE_URL}/v1/video/tasks" \
  --header "Authorization: Bearer ${CHENVOYA_API_KEY}"

import urllib.request
import urllib.parse
import json
import os
import sys
import re
import uuid

key = os.environ["CHENVOYA_API_KEY"].strip()
if not key or re.search(r"[\x00-\x1f\x7f-\x9f]", key):
    sys.exit("Set CHENVOYA_API_KEY to a non-empty value without control characters")
base = os.environ["CHENVOYA_BASE_URL"].rstrip("/")
headers = {"Authorization": "Bearer " + key}
path = "/v1/video/tasks"
request = urllib.request.Request(base + path, data=None, headers=headers, method="GET")
try:
    with urllib.request.urlopen(request) as response:
        print(response.read().decode("utf-8"))
except urllib.request.HTTPError as error:
    print(error.read().decode("utf-8"))
    sys.exit(1)

// Needs Node.js 20 or later; save it as a .mjs file and run it.
const key = process.env.CHENVOYA_API_KEY?.trim();
if (!key || /[\x00-\x1f\x7f-\x9f]/.test(key)) {
  console.error("Set CHENVOYA_API_KEY to a non-empty value without control characters");
  process.exit(1);
}
const base = process.env.CHENVOYA_BASE_URL;
if (!base) throw new Error("Set CHENVOYA_BASE_URL");
const headers = {Authorization: `Bearer ${key}`};
const path = "/v1/video/tasks";
const response = await fetch(base.replace(/\/$/, "") + path, {method: "GET", headers, body: undefined});
console.log(await response.text());
if (!response.ok) process.exitCode = 1;

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"regexp"
	"strings"
)

func main() {
	key := strings.TrimSpace(os.Getenv("CHENVOYA_API_KEY"))
	if key == "" || regexp.MustCompile(`[\x00-\x1f\x7f-\x9f]`).MatchString(key) {
		fail("Set CHENVOYA_API_KEY to a non-empty value without control characters")
	}
	base := strings.TrimRight(os.Getenv("CHENVOYA_BASE_URL"), "/")
	if base == "" {
		fail("Set CHENVOYA_BASE_URL")
	}
	path := "/v1/video/tasks"
	request, err := http.NewRequest("GET", base+path, nil)
	if err != nil {
		fail(err.Error())
	}
	request.Header.Set("Authorization", "Bearer "+key)
	response, err := http.DefaultClient.Do(request)
	if err != nil {
		fail(err.Error())
	}
	text, err := io.ReadAll(response.Body)
	response.Body.Close()
	if err != nil {
		fail(err.Error())
	}
	fmt.Println(string(text))
	if response.StatusCode < 200 || response.StatusCode > 299 {
		os.Exit(1)
	}
}

func fail(message string) {
	fmt.Fprintln(os.Stderr, message)
	os.Exit(1)
}

ReturnsHTTP 200

One page of the current team's tasks.

#objectstringRequired

Identifies the kind of object returned.

Alwayslist

#dataarrayRequired

Task entries included in this page.

Items≤ 100

12 child fields

#idstringRequired

ID of the task in this list entry.

Length4–128CharactersA–Z a–z 0–9 _ -

#request_idstringRequired

Request ID used to correlate this task.

Length4–128CharactersA–Z a–z 0–9 _ -

#billing_correlation_idstringRequired

Billing correlation ID for this task.

Length4–128CharactersA–Z a–z 0–9 _ -

#modelstringRequired

ID of the model used for this request.

dreamina-seedance-2-0-260128Seedance 2.0

dreamina-seedance-2-0-fast-260128Seedance 2.0 Fast

dreamina-seedance-2-0-mini-260615Seedance 2.0 Mini

#statusstringRequired

Current state; see the value notes for its meaning.

queuedQueued

processingProcessing

succeededSucceeded

failedFailed

cancelledCancelled

#phasestringRequiredNullable

Current execution phase, or null when no phase applies.

preparing_assetsPreparing inputs

waiting_routeWaiting

submittingStarting

provider_processingGenerating

reconcilingConfirming the result

finalizingFinishing

settlement_pendingAwaiting settlement

nullNull value

#delivery_statusstringRequired

Progress of result file delivery.

pendingNot yet delivered

materializingPreparing the download

availableReady to download

output_unavailableResult unavailable

#settlement_statusstringRequired

Current progress of billing settlement.

reservedReserved

pendingPending

reconciliation_requiredUnder review

settledSettled

settled_with_receivableSettled - amount due

#created_atintegerRequired

Creation time as whole seconds since the Unix epoch.

Range≥ 0

#started_atintegerRequiredNullable

Time the task started, or null before it starts.

Range≥ 0

#completed_atintegerRequiredNullable

Time the task finished, or null while unfinished.

Range≥ 0

#cancellationobjectNullable

Stable Cancellation ID, status and reason code when a cancellation operation exists. Omitted otherwise.

3 child fields

#cancel_operation_idstringRequired

Stable ID of the cancellation operation.

Length4–128CharactersA–Z a–z 0–9 _ -

#statusstringRequired

Current state; see the value notes for its meaning.

requestedRequested

effectiveCancelled

not_effectiveNot cancelled

failedFailed

#reason_codestringRequiredNullable

Reason cancellation did not take effect or failed. Null when requested or effective.

Length1–96Charactersa–z 0–9 _

#next_cursorstringRequiredNullable

Value for requesting the next page, or null on the last page.

Length1–256

Response headers

#X-Request-IDstringRequired

The identifier of this request: the valid value you sent, or its replacement.

Response

{
  "object": "list",
  "data": [
    {
      "id": "task_32ae2a5177b310d3bc1ec83a98f63889",
      "request_id": "req_6acd96894df9798feb0ddb21e5a52d70",
      "billing_correlation_id": "billcorr_2f6c57065a4404b27fb9b6b24ea9a0d0",
      "model": "dreamina-seedance-2-0-260128",
      "status": "succeeded",
      "phase": null,
      "delivery_status": "available",
      "settlement_status": "settled",
      "created_at": 1793167380,
      "started_at": 1793167381,
      "completed_at": 1793167382
    }
  ],
  "next_cursor": null
}

{
  "error": {
    "code": "invalid_request",
    "message": "request parameters are invalid"
  },
  "trace_id": "trace_error_example"
}

{
  "error": {
    "code": "rate_limited",
    "message": "request rate limit exceeded"
  },
  "trace_id": "trace_error_example"
}

Status codes

Each error.code and what to do about it is on Error codes.

Status	Meaning and error.code
200	One page of the current team's tasks.
400	The submitted request is not valid. invalid_request
401	The API key is missing or invalid. Response headers`WWW-Authenticate` authentication_failed
429	The request rate limit blocks this read operation. Response headers`Retry-After` rate_limited
500	Internal error. internal_error
503	The service is temporarily unavailable. dependency_unavailable

Task status and results Request conventions

List team tasks

Headers

Query parameters

ReturnsHTTP 200

Response headers

Status codes

Related guides