Docs

Running a model

Cancel a request

PUT/<address>/requests/{request_id}/cancelon https://queue.auray.run

202 means REQUESTED, not cancelled: a model can decline to stop and keep going, so the body carries cancelled and the settled charge for a caller who needs to know which happened.

202 means REQUESTED, not cancelled: a model can decline to stop and keep going, so the body carries cancelled and the settled charge for a caller who needs to know which happened. POST to the same address answers this platform's own cancel envelope, unchanged.

#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.

#Example request

curl -X PUT https://queue.auray.run/auray-ai/hunyuan-3d/image-to-3d/requests/photo_docs-mtpb1vnh/cancel \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#202 Accepted

The cancellation was accepted.

FieldTypeRequiredDefaultDescription
statusstringyes—
request_idstringyes—
job_idstringyes—The same job reference as request_id, under the one name every host uses.
productstringno—
job_statusstringno—
settledbooleanno—
cancelledbooleanyes—
credits_chargedintegerno—What the job cost after the cancel's refund — the ledger's net; null, with settled_unknown, when it could not be read. May be null.
credits_reservedintegerno—What was taken when the job was charged. May be null.
settled_unknownbooleanno—Present, and true, when the cancel happened and its figures could not be read.

#400 Bad Request

A refusal.

The error body: error, message, docs (the entry that explains it) and request_id.

#404 Not Found

A refusal.

The error body: error, message, docs (the entry that explains it) and request_id.

#Status codes

StatusMeaning
202The cancellation was accepted.
400A refusal.
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