Docs

Start here

List jobs, newest first

GET/v1/jobson https://api.auray.ai/v1

How a lost id is recovered.

How a lost id is recovered. Newest first across every product, or one with product. Every filter runs inside each product's read — settled and status narrow what is read, never a page after it was cut — so each page is full while older matches exist, and next_before is present exactly when there is another page, whether one product is listed or all of them. Statuses are as fresh as each job's last update; GET /jobs/{id} refreshes one.

#Authentication

Authorization: Bearer auray_sk_… — jobs:read.

#Request

#Query parameters

NameTypeRequiredDescription
productanyno
limitintegerno1 to 100.
settledstringnotrue for jobs that have stopped (succeeded, failed or cancelled), false for those still queued or running. Any other value is refused 400 bad_value. One of "true", "false".
statusstringnoOne or more of queued, running, succeeded, failed, cancelled, separated by commas. Combined with settled, a job must match both. An unknown word is refused 400 bad_value with the allowed list.
beforestringnoCursor. Feed back the next_before from the previous page; the next page starts strictly older than it.
modelstringnoOnly jobs submitted to this address — the string each job prints as model.

#Example request

curl https://api.auray.ai/v1/jobs \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#200 OK

OK

FieldTypeRequiredDefaultDescription
objectstringno—One of "list".
dataobject[]no—
data[].idstringno—
data[].job_idstringno—The job's one id on every host: id here, request_id on the queue host (the queue protocol's name for it).
data[].objectstringno—One of "job".
data[].productstringno—external covers every model somebody else runs, each at its own address. chat is accepted and delivers no webhook event: a chat turn is answered by the request that paid for it. One of "photo", "music", "video", "threed", "chat", "external".
data[].modelstringno—The address the job was submitted to. May be null.
data[].statusstringno—Five words, whatever the product. Our internals disagree; you never see that. One of "queued", "running", "succeeded", "failed", "cancelled".
data[].credits_chargedintegerno—What the job cost, after any refund — the ledger's net for it, the same figure on every door.
data[].credits_reservedintegerno—What was taken when the job was charged, before any refund.
data[].settledbooleanno—
data[].originstringno—Which door the job came in by. NOT the same vocabulary as /usage, which says app rather than ui for the same idea — the jobs tables and the credit ledger were given different words and both are load-bearing. Chat turns always read ui: chat_messages has no origin column. One of "ui", "api".
data[].created_atstringno—When it was submitted. This is the field the list is ordered by, and the value to feed back as ?before=.
next_beforestringno—Present exactly when there is another page. It is the created_at of the last row read for this page. May be null.
request_idstringno—Mirrored in the X-Request-Id header. It sits here, on the envelope, not on each item.

Headers:

HeaderDescription
RateLimit-LimitBurst capacity.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-ResetUnix seconds. The X- spelling is what client libraries read.
X-Request-Id

#400 Bad Request

#401 Unauthorized

#403 Forbidden

#429 Too Many Requests

#500 Internal Server Error

job_read_failed — one product's jobs could not be read, and product says which. It used to be answered as a list without that product's jobs; retry, nothing changed.

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

#503 Service Unavailable

#Status codes

StatusMeaning
200OK
400Bad Request
401Unauthorized
403Forbidden
429Too Many Requests
500job_read_failed — one product's jobs could not be read, and product says which.
503Service Unavailable

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