Get a workspace's AI credit balance

GET 
/panel/workspaces/:workspace/ai-credits

Returns the workspace's AI credit availability.

• balance — the remaining credit as a number rounded to 2 decimal places. It is null when the workspace has no credit record and when the balance is exactly zero; the two cases are indistinguishable from this response.
• low — true when the balance is greater than 0 and no more than 10.
• available — in practice always true; do not rely on it to detect an exhausted balance. Use balance and low instead.

Request

Responses

200

AI credit availability snapshot.

401

The bearer token is missing, malformed, unknown, or expired.

403

The token is valid, but the user it belongs to may not perform this action:

• they are not a member of the {workspace} in the path; or
• their workspace role is too low for this endpoint (write routes require Admin or Member); or
• for /panel endpoints, they are not a platform administrator.

The host application that Mixpost is installed into can also deny access to Mixpost as a whole, which produces the same response.

404

The {workspace} UUID in the path does not match any workspace.