Usage
Read remaining credits, monthly credits, recent render count, and daily usage.
GET
/v1/usage
Authentication
Bearer Token
Responses
200
Usage summary
application/jsoncredits_remaining
integer
credits_monthly
integer
last_30_days
object
render_count
integer
credits_used
integer
daily_breakdown
object[]
Array of:
day
string
renders
integer
credits
integer
401
Error response
403
Error response
curl -X GET 'https://screenframed.com/v1/usage' \ -H 'Authorization: Bearer YOUR_API_TOKEN'
const response = await fetch('https://screenframed.com/v1/usage', { method: 'GET', headers: { "Authorization": "Bearer YOUR_API_TOKEN" }});const data = await response.json();console.log(data);
import requestsheaders = { 'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.get('https://screenframed.com/v1/usage', headers=headers)print(response.json())
200
Response
{ "credits_remaining": 123, "credits_monthly": 123, "last_30_days": { "render_count": 123, "credits_used": 123 }, "daily_breakdown": [ { "day": "<string>", "renders": 123, "credits": 123 } ]}
API Playground
Try this endpoint
GET
/v1/usage