Reference

GET /grid

The grid's state right now: the capture queue, running workers and session slots.

Syntax

GET https://grid-lab.zyxio.xyz/grid
x-api-key: <key>

Name	Where	Required	Meaning
`x-api-key`	header	yes, or `Authorization`	Your API key, or `Authorization: Bearer <token>` from Zyxio sign-in.

200 OK

Field	Meaning
`queue.wait`	Capture items waiting, without a priority.
`queue.prioritized`	Capture items waiting with a priority.
`queue.delayed`	Capture items waiting to be retried.
`workers`	Capture workers running now. 0 on a quiet grid: workers start on demand, so the first results after a quiet spell take a minute or two.
`sessions`	Browser sessions in use, by everyone.
`maxSessions`	The grid's session slots in total.

The figures cover the whole grid, not just your work.

Status	Body	When	What to do
`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.

curl -s https://grid-lab.zyxio.xyz/grid -H "x-api-key: $BROWSERGRID_API_KEY"

{"queue": {"wait": 0, "prioritized": 0, "delayed": 0}, "workers": 0, "sessions": 2, "maxSessions": 10}

The numbers show the shape of an answer, not the grid's size.

Free.