List generations

Lists generations for a namespace. By default only returns active generations (status queued or processing). Pass an explicit status to include terminal states, or filter by model, media_type, repo, or folder.

GET /api/ai/queue

List generations

cURL

curl --request GET \
  --url https://dev.hub.oxen.ai/api/ai/queue

import requests

url = "https://dev.hub.oxen.ai/api/ai/queue"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://dev.hub.oxen.ai/api/ai/queue', 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://dev.hub.oxen.ai/api/ai/queue",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://dev.hub.oxen.ai/api/ai/queue"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://dev.hub.oxen.ai/api/ai/queue")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.hub.oxen.ai/api/ai/queue")

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

request = Net::HTTP::Get.new(url)

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

200

{
  "count": 123,
  "generations": [
    {
      "enqueued_at": 123,
      "generation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "model_name": "<string>",
      "completed_at": 123,
      "error_message": "<string>",
      "result_url": "<string>",
      "started_at": 123,
      "target_directory": "<string>",
      "target_namespace": "<string>",
      "target_repo": "<string>"
    }
  ]
}

Query Parameters

namespace · string

model · string

media_type · enum<string>

Available options: image, video

status · enum<string>

Available options: queued, processing, succeeded, failed, cancelled

repo · string

folder · string

Response

200 - application/json

Generation list

Lists generations for a namespace. By default only active generations (status queued or processing) are returned; pass an explicit status filter to include terminal states. Each generation includes any additional parameters from the request that queued it.

count · integer · required

generations · object[] · required

Show child attributes