Calls
Usage
Read the workspace's full-speed search time this month, what is left, the lane the next nest or load runs in, and on Free the loads left.
GET /v1/usage reads the workspace's search pool, and on Free its loads this month. It is a free call, so a client can show what is left before starting a job, or decide whether to ask for the deep lane.
curl https://api.nestsolver.com/v1/usage -H "Authorization: Bearer $NESTSOLVER_KEY"
The answer:
{
"plan": "shop",
"pool_seconds": 90000,
"used_seconds": 61380,
"left_seconds": 28620,
"next_lane": "full_speed",
"loads_limit": null,
"loads_used": null,
"loads_left": null
}
Fields
| Field | Meaning |
|---|---|
plan |
The workspace's tier: free, bench, shop or works. |
pool_seconds |
This month's full-speed search time, from the tier. |
used_seconds |
How much of it the month's nests and loads have spent, over the web, the API and MCP together. |
left_seconds |
What remains. |
next_lane |
Where the next nest or load will search unless it asks for the deep lane: full_speed while the pool lasts, slower once it is spent. |
loads_limit |
On Free, the loads the workspace may start this month: 5. null on paid plans, which have no monthly load cap. |
loads_used |
On Free, the loads started this month, failed ones aside. null on paid plans. |
loads_left |
On Free, the loads left this month. null on paid plans. |
On Free, read the loads fields rather than the pool: every one of its 5 loads runs at full speed. The pool and the loads are per calendar month (UTC). Linear and sheet solves never draw on it. Plans and limits explains the pool and the lanes.