Running a model
Read a request's status
/<address>/requests/{request_id}/statuson https://queue.auray.runThe same document the result answers, and it is 200 for a failed or unfinished request where the result is not: this address reports, the result IS the output.
The same document the result answers, and it is 200 for a failed or unfinished request where the result is not: this address reports, the result IS the output. GET /auray-ai/hunyuan-3d/image-to-3d/requests/{request_id}/status/stream streams this document as text/event-stream until it is COMPLETED; each stream closes after about five minutes with no final frame, having sent retry: at its top, so reconnect and keep reading until COMPLETED — every frame is the whole status, and the official clients reconnect on their own. It takes a seat from the same pool wait does and is 503 stream_declined when none is free.
#Authentication
Authorization: Bearer auray_sk_… — a key with the scope the route names.
#Request
#Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
request_id | string | yes | The request_id the submit answered with. |
#Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
logs | string | no | Include the runner's log lines on a read. Off by default, because a status polled at 10 Hz that carries a growing log is the same lines paid for a hundred times. One of "1", "0", "true", "false". |
#Example request
curl https://queue.auray.run/auray-ai/hunyuan-3d/image-to-3d/requests/photo_docs-mtpb1vnh/status \
-H "Authorization: Bearer $AURAY_API_KEY"import { createClient } from "@auray/client";
const auray = createClient(); // reads AURAY_API_KEY
const status = await auray.queue.status("auray-ai/hunyuan-3d/image-to-3d", { requestId: "photo_docs-mtpb1vnh", logs: true });
console.log(status.status);from auray_client import Client
auray = Client() # reads AURAY_API_KEY
status = auray.queue.status("auray-ai/hunyuan-3d/image-to-3d", request_id="photo_docs-mtpb1vnh", logs=True)
print(status["status"]){
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "check_job",
"arguments": {
"address": "auray-ai/hunyuan-3d/image-to-3d",
"request_id": "photo_docs-mtpb1vnh"
}
}
}const res = await fetch("https://queue.auray.run/auray-ai/hunyuan-3d/image-to-3d/requests/photo_docs-mtpb1vnh/status", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.AURAY_API_KEY}` },
});
console.log(await res.json());import os, requests
r = requests.get(
"https://queue.auray.run/auray-ai/hunyuan-3d/image-to-3d/requests/photo_docs-mtpb1vnh/status",
headers={"Authorization": f"Bearer {os.environ['AURAY_API_KEY']}"},
)
r.raise_for_status()
print(r.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://queue.auray.run/auray-ai/hunyuan-3d/image-to-3d/requests/photo_docs-mtpb1vnh/status", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("AURAY_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}<?php
$ch = curl_init("https://queue.auray.run/auray-ai/hunyuan-3d/image-to-3d/requests/photo_docs-mtpb1vnh/status");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("AURAY_API_KEY"),
],
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response, PHP_EOL;require "net/http"
uri = URI("https://queue.auray.run/auray-ai/hunyuan-3d/image-to-3d/requests/photo_docs-mtpb1vnh/status")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("AURAY_API_KEY")}"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, res.bodyimport java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://queue.auray.run/auray-ai/hunyuan-3d/image-to-3d/requests/photo_docs-mtpb1vnh/status"))
.header("Authorization", "Bearer " + System.getenv("AURAY_API_KEY"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("AURAY_API_KEY"));
using var request = new HttpRequestMessage(HttpMethod.Get, "https://queue.auray.run/auray-ai/hunyuan-3d/image-to-3d/requests/photo_docs-mtpb1vnh/status");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");#Responses
#200 OK
Where the request is.
#404 Not Found
A refusal.
The error body: error, message, docs (the entry that explains it) and request_id.
#Status codes
| Status | Meaning |
|---|---|
200 | Where the request is. |
404 | A refusal. |
Every refusal names its code, and every code is explained at Errors.