Cancel generation

Cancels a generation. The row is retained with status set to cancelled.

DELETE /api/ai/queue/{generation_id}

Cancel generation

cURL

curl --request DELETE \
  --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.delete(url)

print(response.text)

const options = {method: 'DELETE'};

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 => "DELETE",
]);

$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("DELETE", url, nil)

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("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::Delete.new(url)

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

200

{
  "generation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "success"
}

{}

Path Parameters

generation_id · string · required

Response

200

application/json

Generation cancelled

generation_id · string<uuid> · required

status · enum<string> · required

Available options: success