GET /jobs
Your analytical jobs, newest first, filtered by phase or by one label, a page at a time.
Syntax
GET https://grid-lab.zyxio.xyz/jobs?limit=<n>&cursor=<cursor>&phase=<phase>&label.<key>=<value>
x-api-key: <key>Request
| Name | Where | Required | Meaning |
|---|---|---|---|
x-api-key | header | yes, or Authorization | Your API key, or Authorization: Bearer <token> from Zyxio sign-in. |
limit | query | no | 1 to 100 jobs per page. Default 50. |
cursor | query | no | The nextCursor of the previous page. |
phase | query | no | One phase, such as RUNNING or FAILED. |
label.<key> | query | no | One label filter, such as label.run=demo. At most one. |
Any other query parameter is refused. Capture items are not listed here; they are listed per batch by GET /batches/{batchId}.
Response
200 OK
| Field | Meaning |
|---|---|
jobs | Job records as GET /jobs/{jobId} shows them. |
nextCursor | The cursor for the next page, or null on the last page. |
Errors
| Status | Body | When | What to do |
|---|---|---|---|
400 | {"error": "INVALID_LIST_QUERY"} | An unknown parameter, a bad phase or label, limit out of range, or two label filters. | Fix the query. |
400 | {"error": "INVALID_LIST_CURSOR"} | The cursor is not one this call gave you. | Start again without a cursor. |
401 | {"error": "unauthorized"} | No credential, or a key that is revoked, expired, wrong, or of a suspended account. | Send a valid key. |
503 | {"error": "accounting_unavailable"} | Your key or Zyxio sign-in could not be checked because the account database did not answer in time. Nothing was done. | Retry shortly; the same request is safe to resend. |
403 | {"error": "forbidden"} | A valid Zyxio sign-in token whose identity has no account here, or whose account is suspended. | Accept your invitation first, or use a key. |
503 | {"error": "COMPUTE_UNAVAILABLE"} | The job store did not answer in time. | Retry after the retry-after seconds. |
Example
curl -s 'https://grid-lab.zyxio.xyz/jobs?limit=10&label.run=demo' -H "x-api-key: $BROWSERGRID_API_KEY"{"jobs": [{"jobId": "cj_0123456789abcdef0123456789abcdef", "phase": "SUCCEEDED", "attempt": 1}], "nextCursor": null}The example's job record is shortened.
Billing
Free.