Usage

Check your remaining API credits.

Check how many credits your organization has remaining. Credits are shared between the API and the Pixii app. credits.remaining is your plan balance; extra credit packs are spent automatically when it runs short and are not included in this number.

Endpoint

GET /v2/api/usage

Response fields

Field	Type	Description
`credits.remaining`	number	Credits remaining for your organization.

Credit costs

Endpoint	Credits
Create listing	70 per listing
Create anything	Per deliverable: 10 per image, 30 per A+ format (10 for one-module), 40 per video, 1 for title and bullets
Scale	Per master visual per product: 10 per image, 10 to 30 per A+ format, 40 per video
Creative strategy	5
Download visuals	Free

Every submit response reports the job’s credit_cost and your remaining_credits. Failed jobs and failed visuals are refunded automatically.

Errors

Code	HTTP	Description
`UNAUTHORIZED`	401	Missing or invalid API key

Get usage

curl https://api.pixii.ai/v2/api/usage \
-H "Authorization: Bearer pk_live_xxxxxxxxxxxx"

import requests

response = requests.get(
"https://api.pixii.ai/v2/api/usage",
headers={"Authorization": "Bearer pk_live_xxxxxxxxxxxx"},
)

Response json

{

"success": true,
"data": {
"credits": {
"remaining": 8740
}
},
"error": null
}

Error response json

{

"success": false,
"data": null,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"detail": null
}
}

See the errors reference for the full list of error codes and how to handle them.