Get generation status

Retrieves metadata for a single queued generation.

GET /api/ai/queue/{generation_id}

Get generation status

cURL

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

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://dev.hub.oxen.ai/api/ai/queue/{generation_id}', 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/{generation_id}",
  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/{generation_id}"

	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/{generation_id}")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "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>"
}

{}

Path Parameters

generation_id · string · required

Response

200

application/json

Generation details

Metadata for a single generation. Rows persist after terminal state transitions (succeeded, failed, cancelled), so this endpoint returns 200 with the final status and result_url once the row is complete. The response also includes any additional parameters from the request that queued it.

enqueued_at · integer · required

Unix timestamp

generation_id · string<uuid> · required

media_type · enum<string> · required

Available options: image, video

model_name · string · required

status · enum<string> · required

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

completed_at · integer | null

Unix timestamp

error_message · string | null

result_url · string | null

started_at · integer | null

Unix timestamp

target_directory · string | null

target_namespace · string | null

target_repo · string | null