List tasks

curl --request GET \
  --url https://api.gumnut.ai/api/tasks/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gumnut.ai/api/tasks/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gumnut.ai/api/tasks/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gumnut.ai/api/tasks/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gumnut.ai/api/tasks/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "asset_id": "<string>",
    "task_type": "embedding",
    "celery_task_id": "<string>",
    "status": "pending",
    "result": "<string>",
    "outcome": "<string>",
    "error_message": "<string>",
    "retry_count": 123,
    "created_at": "<string>",
    "started_at": "<string>",
    "completed_at": "<string>"
  }
]

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

GET

api

tasks

List tasks

curl --request GET \
  --url https://api.gumnut.ai/api/tasks/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gumnut.ai/api/tasks/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gumnut.ai/api/tasks/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gumnut.ai/api/tasks/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gumnut.ai/api/tasks/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "asset_id": "<string>",
    "task_type": "embedding",
    "celery_task_id": "<string>",
    "status": "pending",
    "result": "<string>",
    "outcome": "<string>",
    "error_message": "<string>",
    "retry_count": 123,
    "created_at": "<string>",
    "started_at": "<string>",
    "completed_at": "<string>"
  }
]

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Gumnut API key (apikey_...) sent as a Bearer token in the Authorization header. Create and manage keys in the Gumnut app, or with the API key endpoints while signed in to it.

Query Parameters

library_id

string | null

Restrict results to tasks owned by this library. When omitted, returns tasks across every library the authenticated user can access.

status

enum<string> | null

Return only tasks currently in this execution status. Status of a background task execution: pending (created and awaiting processing), started (picked up by a worker and not yet in a terminal state — the task may be executing or awaiting an automatic retry after a transient failure), success (completed successfully), or failure (failed and will not be retried).

Available options:

pending,

started,

success,

failure

task_type

enum<string> | null

Return only tasks of this type. Kind of background processing a task performs: embedding (compute the content embedding that powers search), face_detection (detect faces in an asset), face_clustering (group a library's detected faces into people), asset_description (generate a natural-language description of an asset), asset_storage_cleanup (remove stored files left behind by a permanently deleted asset), asset_version_storage_cleanup (remove stored files of a superseded asset version), reverse_geocoding (resolve an asset's GPS coordinates to a place name), video_thumbnail_extract (extract a thumbnail image from a video), video_metadata_extract (recover a video's capture time, GPS location, and camera details from the file's own metadata), thumbhash (compute the blurred placeholder shown while a thumbnail loads), display_proxy_generation (generate a browser-displayable rendition of an original the image CDN cannot transform, such as an oversized or over-dimensioned file), burst_detection (detect rapid-fire shots of the same moment and stack them), product_update_subscription (enroll an explicitly opted-in new user in product-update email delivery), person_metrics_refresh (recompute the face-matching summary of one person after their faces change), or quality_scoring (rate an image's photographic quality).

Available options:

embedding,

face_detection,

face_clustering,

asset_description,

asset_storage_cleanup,

asset_version_storage_cleanup,

reverse_geocoding,

video_thumbnail_extract,

video_metadata_extract,

thumbhash,

display_proxy_generation,

burst_detection,

product_update_subscription,

person_metrics_refresh,

quality_scoring

limit

integer

default:20

Maximum number of tasks to return.

Required range: 1 <= x <= 200

Response

Successful Response

string

required

Unique task identifier with btask_ prefix

asset_id

string | null

required

ID of the asset this task processes; null for library-scoped tasks such as face clustering

task_type

enum<string>

required

Kind of background processing a task performs: embedding (compute the content embedding that powers search), face_detection (detect faces in an asset), face_clustering (group a library's detected faces into people), asset_description (generate a natural-language description of an asset), asset_storage_cleanup (remove stored files left behind by a permanently deleted asset), asset_version_storage_cleanup (remove stored files of a superseded asset version), reverse_geocoding (resolve an asset's GPS coordinates to a place name), video_thumbnail_extract (extract a thumbnail image from a video), video_metadata_extract (recover a video's capture time, GPS location, and camera details from the file's own metadata), thumbhash (compute the blurred placeholder shown while a thumbnail loads), display_proxy_generation (generate a browser-displayable rendition of an original the image CDN cannot transform, such as an oversized or over-dimensioned file), burst_detection (detect rapid-fire shots of the same moment and stack them), product_update_subscription (enroll an explicitly opted-in new user in product-update email delivery), person_metrics_refresh (recompute the face-matching summary of one person after their faces change), or quality_scoring (rate an image's photographic quality).

Available options:

embedding,

face_detection,

face_clustering,

asset_description,

asset_storage_cleanup,

asset_version_storage_cleanup,

reverse_geocoding,

video_thumbnail_extract,

video_metadata_extract,

thumbhash,

display_proxy_generation,

burst_detection,

product_update_subscription,

person_metrics_refresh,

quality_scoring

celery_task_id

string

required

deprecated

Deprecated alternate task identifier. Use id instead.

status

enum<string>

required

Status of a background task execution: pending (created and awaiting processing), started (picked up by a worker and not yet in a terminal state — the task may be executing or awaiting an automatic retry after a transient failure), success (completed successfully), or failure (failed and will not be retried).

Available options:

pending,

started,

success,

failure

result

string | null

required

Result summary produced by a completed task; null until success

outcome

string | null

required

Stable outcome code whose meaning depends on task_type. For a successful face_detection task: ran means detection ran, possibly finding no faces; skipped_photo_location means automatic detection is not offered at the photo's location; skipped_location_unread means the photo has no location and its file's metadata has not been read; skipped_owner_off means the library owner had not turned detection on when the photo was processed; skipped_owner_region means detection is not offered in the owner's home region. Turning detection on later does not process earlier photos. Null for other task types, tasks that have not succeeded, and skips with no explanation, such as files that are not images. Each task reports its own run. Codes may be added for any task type; treat an unrecognized code as no explanation.

error_message

string | null

required

Error detail from the most recent failed or retried attempt; not cleared by a later success, so it can be non-null on a task that failed transiently and then succeeded. Null if no attempt has failed

retry_count

integer

required

Retry and rescue bookkeeping value for this task. Zero before any automatic retry or stuck-task rescue; not guaranteed to be a cumulative delivery count

created_at

string

required

When the task record was created (ISO 8601); dispatch to the task queue follows separately, after the creating transaction commits

started_at

string | null

required

When a worker most recently began executing the task, or when the stuck-task reaper rescued it back to pending (ISO 8601). Because a rescue can re-enqueue a task no worker ever picked up, a non-null value does not prove a worker has run the task

completed_at

string | null

required

When the task finished, whether successfully or not (ISO 8601); null until then

oauth

assets

album-assets

albums

events

library-invitations

libraries

search

faces

feedback

people

api-keys

server

stacks

tasks

users

List tasks

Authorizations

Query Parameters

Response