Get credit balance
curl --request GET \
--url https://api.evalezy.com/v1/credits \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.evalezy.com/v1/credits"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.evalezy.com/v1/credits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"balance": 5000,
"credit_limit": 0,
"committed": 48,
"available": 4952,
"rate_card": {
"tool": "copy_check_evaluation_api",
"unit": "page",
"credits_per_page": 1,
"typed_credits_per_answer": 1,
"fixed_price": true,
"rate_source": "standard"
},
"spent_30d": {
"copies": 214,
"pages": 2368,
"credits": 2368
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key is not valid.",
"request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
}
}{
"error": {
"code": "insufficient_scope",
"message": "This API key lacks the evaluation:write scope.",
"request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f",
"details": {
"required_scope": "evaluation:write"
}
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after 2 s.",
"request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
}
}Credits
Get credit balance
Returns the institute’s credit balance, credits committed to queued and running evaluations, what is available, the rate card and the last 30 days’ spend.
Scope: evaluation:read
GET
/
credits
Get credit balance
curl --request GET \
--url https://api.evalezy.com/v1/credits \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.evalezy.com/v1/credits"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.evalezy.com/v1/credits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"balance": 5000,
"credit_limit": 0,
"committed": 48,
"available": 4952,
"rate_card": {
"tool": "copy_check_evaluation_api",
"unit": "page",
"credits_per_page": 1,
"typed_credits_per_answer": 1,
"fixed_price": true,
"rate_source": "standard"
},
"spent_30d": {
"copies": 214,
"pages": 2368,
"credits": 2368
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key is not valid.",
"request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
}
}{
"error": {
"code": "insufficient_scope",
"message": "This API key lacks the evaluation:write scope.",
"request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f",
"details": {
"required_scope": "evaluation:write"
}
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after 2 s.",
"request_id": "req_4f9c2a7e1b3d4c8a9e6f0b2d5a7c1e3f"
}
}Authorizations
Your institute's API key, vak_eval_ followed by 48 hex characters. An institute admin creates keys in the dashboard under Settings -> Integrations -> API keys.