curl --request GET \
--url https://app.octavehq.com/api/v2/api-key/validate \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"status": "ok",
"valid": true,
"credits": {
"totalUsed": 175,
"totalRemaining": 425,
"totalMax": 575,
"quotaUsed": 150,
"quotaAvailable": 350,
"quotaMax": 500,
"period": "month",
"creditsUsed": 25,
"creditsAvailable": 75
}
}This endpoint validates the API key provided in the header. If the request succeeds, the API key is valid. Rate limited to 1000 requests per minute.
curl --request GET \
--url https://app.octavehq.com/api/v2/api-key/validate \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"status": "ok",
"valid": true,
"credits": {
"totalUsed": 175,
"totalRemaining": 425,
"totalMax": 575,
"quotaUsed": 150,
"quotaAvailable": 350,
"quotaMax": 500,
"period": "month",
"creditsUsed": 25,
"creditsAvailable": 75
}
}API key is valid
Status of the API key validation
ok "ok"
Whether the API key is valid
true
Credit usage information for the API key
Show child attributes
Total credits used (quota + subscription credits)
175
Total credits remaining (quota + subscription credits)
425
Total maximum credits available (quota + subscription credits)
575
Number of credits used in the current period
150
Number of credits available in the current period
350
Maximum credits allowed in the current period
500
The tracking period for the credits (month, life, etc.)
"month"
Credits used from subscription credit pool
25
Credits available from subscription credit pool
75