Account & setup
Get API key usage
Get the 30-day request total and created Boxes and Agents for one API key.
GET
/
api-keys
/
{apiKeyId}
/
usage
Get API key usage
curl --request GET \
--url https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage \
--header 'Authorization: Bearer <token>'import requests
url = "https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ok": true,
"type": "api_key.usage",
"id": "sak_123",
"name": "Production worker",
"keyPrefix": "box_live",
"keyLastFour": "9abc",
"sandboxId": null,
"createdAt": "2026-05-31T12:00:00Z",
"lastUsedAt": "2026-08-25T09:30:00Z",
"usage": {
"requests": 1842,
"windowDays": 30
},
"resources": {
"total": 2,
"boxes": 1,
"agents": 1
},
"createdResources": [
{
"kind": "box",
"id": "bx_123",
"name": "CI build",
"state": "ready",
"createdAt": "2026-08-24T14:00:00Z"
},
{
"kind": "agent",
"id": "agent_456",
"name": "Review",
"state": "idle",
"createdAt": "2026-08-23T12:00:00Z"
}
]
}{
"ok": false,
"type": "box.error",
"status": 401,
"code": "unauthorized",
"message": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized",
"status": 401
},
"requestId": "req_01HX..."
}{
"ok": false,
"type": "box.error",
"status": 409,
"code": "provider_not_configured",
"message": "Prompting is locked until Codex is configured on the Agents page.",
"requestId": "req_01HX...",
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
}
}Authorizations
Box bearer token in the form box_.... Service API keys authenticate Box operations.
Path Parameters
API key ID returned by GET /api-keys.
Response
Usage and created resources for the key.
Example:
true
Stable success envelope discriminator added by v1.
Example:
"sak_123"
Example:
"Production worker"
Example:
"box_live"
Example:
"9abc"
Box ID for a platform-managed machine key, or null for a user-created key.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Get API key usage
curl --request GET \
--url https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage \
--header 'Authorization: Bearer <token>'import requests
url = "https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ascii.dev/api/box/v1/api-keys/{apiKeyId}/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ok": true,
"type": "api_key.usage",
"id": "sak_123",
"name": "Production worker",
"keyPrefix": "box_live",
"keyLastFour": "9abc",
"sandboxId": null,
"createdAt": "2026-05-31T12:00:00Z",
"lastUsedAt": "2026-08-25T09:30:00Z",
"usage": {
"requests": 1842,
"windowDays": 30
},
"resources": {
"total": 2,
"boxes": 1,
"agents": 1
},
"createdResources": [
{
"kind": "box",
"id": "bx_123",
"name": "CI build",
"state": "ready",
"createdAt": "2026-08-24T14:00:00Z"
},
{
"kind": "agent",
"id": "agent_456",
"name": "Review",
"state": "idle",
"createdAt": "2026-08-23T12:00:00Z"
}
]
}{
"ok": false,
"type": "box.error",
"status": 401,
"code": "unauthorized",
"message": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized",
"status": 401
},
"requestId": "req_01HX..."
}{
"ok": false,
"type": "box.error",
"status": 409,
"code": "provider_not_configured",
"message": "Prompting is locked until Codex is configured on the Agents page.",
"requestId": "req_01HX...",
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
}
}