Docs

Running a model

Read a request's status

GET/<address>/requests/{request_id}/statuson https://queue.auray.run

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.

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

NameTypeRequiredDescription
request_idstringyesThe request_id the submit answered with.

#Query parameters

NameTypeRequiredDescription
logsstringnoInclude 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"

#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

StatusMeaning
200Where the request is.
404A refusal.

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close