Enqueue generation

Enqueues an async image or video generation job.

POST /api/ai/queue

Enqueue generation

cURL

curl --request POST \
  --url https://dev.hub.oxen.ai/api/ai/queue \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "prompt": "<string>",
  "aspect_ratio": "<string>",
  "duration": 123,
  "num_generations": 1,
  "seed": 123,
  "target_directory": "<string>",
  "target_namespace": "<string>",
  "target_repo": "<string>"
}
'

import requests

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

payload = {
    "model": "<string>",
    "prompt": "<string>",
    "aspect_ratio": "<string>",
    "duration": 123,
    "num_generations": 1,
    "seed": 123,
    "target_directory": "<string>",
    "target_namespace": "<string>",
    "target_repo": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: '<string>',
    prompt: '<string>',
    aspect_ratio: '<string>',
    duration: 123,
    num_generations: 1,
    seed: 123,
    target_directory: '<string>',
    target_namespace: '<string>',
    target_repo: '<string>'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => '<string>',
    'prompt' => '<string>',
    'aspect_ratio' => '<string>',
    'duration' => 123,
    'num_generations' => 1,
    'seed' => 123,
    'target_directory' => '<string>',
    'target_namespace' => '<string>',
    'target_repo' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"aspect_ratio\": \"<string>\",\n  \"duration\": 123,\n  \"num_generations\": 1,\n  \"seed\": 123,\n  \"target_directory\": \"<string>\",\n  \"target_namespace\": \"<string>\",\n  \"target_repo\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://dev.hub.oxen.ai/api/ai/queue")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"aspect_ratio\": \"<string>\",\n  \"duration\": 123,\n  \"num_generations\": 1,\n  \"seed\": 123,\n  \"target_directory\": \"<string>\",\n  \"target_namespace\": \"<string>\",\n  \"target_repo\": \"<string>\"\n}")
  .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::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"aspect_ratio\": \"<string>\",\n  \"duration\": 123,\n  \"num_generations\": 1,\n  \"seed\": 123,\n  \"target_directory\": \"<string>\",\n  \"target_namespace\": \"<string>\",\n  \"target_repo\": \"<string>\"\n}"

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

200

{
  "generations": [
    {
      "generation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "queued"
    }
  ]
}

{}

Body

application/json

Queue request

Enqueue an async image or video generation job.

model · string · required

Model ID to use

prompt · string · required

Text prompt for generation

aspect_ratio · string | null

duration · integer | null

num_generations · integer · default: 1

Required range: 1 <= x <= 12

seed · integer | null

target_directory · string | null

target_namespace · string | null

Namespace to store results. Defaults to current user.

target_repo · string | null

Response

200

application/json

Generation enqueued

generations · object[] · required

Show child attributes