API reference
Projects and usage
List the projects in your organization and read compute usage, credits, and quotas.
Projects group your sandboxes, artifacts, and previews inside an organization, and the usage endpoint reports how much compute your organization has consumed in the current billing period.
List projects
GET /v1/projects
Returns a paginated list of the
projects your API key can access, newest first. Standard limit and
cursor parameters apply.
| Field | Type | Description |
|---|---|---|
id | string | Project ID, prefixed prj_ |
orgId | string | Owning organization, prefixed org_ |
name | string | Project name |
createdAt | string | ISO 8601 creation timestamp |
curl https://api.crownest.dev/v1/projects \
-H "Authorization: Bearer $CROWNEST_API_KEY"{
"data": [
{
"id": "prj_abc123",
"orgId": "org_abc123",
"name": "default",
"createdAt": "2026-06-11T13:00:00.000Z"
}
],
"hasMore": false
}Pass a project's id as projectId when you
create a sandbox or filter a
sandbox list.
Get usage
GET /v1/usage — requires scope usage:read.
Returns compute usage, credit balance, and quota information for the current billing period.
curl https://api.crownest.dev/v1/usage \
-H "Authorization: Bearer $CROWNEST_API_KEY"{
"period": {
"start": "2026-06-01T00:00:00.000Z",
"end": "2026-07-01T00:00:00.000Z",
"resetAt": "2026-07-01T00:00:00.000Z"
},
"pricingVersion": "2026-01",
"computeUnitSecondsPerCredit": 3600,
"computeUnitSeconds": { "used": 18250 },
"credits": { "used": 5.07, "remaining": 94.93 },
"quotas": {}
}Response fields:
| Field | Type | Description |
|---|---|---|
period.start | string | ISO 8601 start of the current billing period |
period.end | string | ISO 8601 end of the current billing period |
period.resetAt | string | ISO 8601 time usage counters reset |
pricingVersion | string | Pricing scheme the figures are computed under |
computeUnitSecondsPerCredit | integer | How many compute unit seconds one credit buys |
computeUnitSeconds.used | number | Compute unit seconds consumed this period |
credits.used | number | Credits consumed this period |
credits.remaining | number | Credits left this period, when your plan has a cap |
quotas | object | Your plan's quotas, such as concurrency and TTL ceilings |
[!NOTE] Quota values are configurable beta defaults. They depend on your plan and may change.
Next steps
- Watch for
quota_exceededresponses in Errors. - Restrict keys to specific projects in Authentication.