Get one workspace
get_workspace
Reads one workspace with its name, plan and AI credits, including a ready-made balance.
The balance arrives as Credits.Balance, alongside the underlying buckets it is worked out from. It is the stored figure, though, and can be stale right after a renewal or a top up, so use get_workspace_credits when the number has to be right.
Check the balance before sending a prompt to a site, because a workspace with less than 0.01 credits left refuses send_message and create_site outright rather than running them a little further. A run that empties the balance while it is still going is stopped at that point instead of finishing past zero, so a message sent on a thin balance can come back from get_job as a failed generation carrying error code SC-6001. See Credits.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
workspaceId |
string | Yes | The workspace id, from list_workspaces. |