AI credit usage

GET 
/:workspaceUuid/usage/ai

The workspace's AI credits: text credits (captions, rewrites, outlines, alt text; counted per billing cycle) and image credits (one per generated, edited or varied image, and one per repurpose carousel; counted per calendar month, UTC). limit and remaining are null when the workspace has no limit. Readable when credits are used up; costs nothing.

When image credits run out, the image endpoints and carousels answer 429 with code: image_credits_exhausted; when text credits run out, the AI endpoints answer 429 with code: ai_credits_exhausted. Image endpoint responses also carry image_credits_used and image_credits_remaining; their credits_used counts text credits only. If the image pool is switched off (image.enabled: false), images cost text credits as before.

Request

Responses

200

Credit usage

401

Missing or invalid API token.

403

Access denied. Returned when the caller is not a member of the workspace, lacks the role the endpoint needs, or the workspace's plan does not include API access (capability api).