> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bead.run/llms.txt
> Use this file to discover all available pages before exploring further.

# Read account limits

> Read your current resource usage, start windows, batch limits, and burst policy.

## Authentication

Send your scoped bearer token in the `Authorization: Bearer <BEAD_TOKEN>` header, or send your API key in `X-API-Key`.

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
curl --request GET \
  --url "https://api.bead.run/v1/limits" \
  --header "X-API-Key: $BEAD_API_KEY"
```

```python Python theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
from beadrun import Bead

client = Bead()
print(client.limits())
client.close()
```

```typescript TypeScript theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
import { Bead } from "@beadrun/sdk";

const client = new Bead();
console.log(await client.limits());
```

## Response

### 200

Current organization admission policy and usage.

**resources** `object` *required*

Organization resource caps and current usage.

**Properties**

**sandbox\_limit** `integer` *required*

Maximum retained machines.

**memory\_limit\_mib** `integer` *required*

Organization memory cap in MiB.

**cpu\_limit** `integer` *required*

Organization CPU cap.

**sandboxes** `integer` *required*

Current machines counted against the cap.

**memory\_mib** `integer` *required*

Current memory allocation in MiB.

**vcpus** `integer` *required*

Current CPU allocation.

**batch\_limits** `object` *required*

Effective batch limits for this policy.

**Properties**

**swarm** `integer` *required*

Maximum swarm batch admitted under the current policy.

**fleet** `integer` *required*

Maximum fleet batch admitted under the current policy.

**fork** `integer` *required*

Maximum fork batch admitted under the current policy.

**policy** `object` *required*

Admission policy applied to your organization.

**Properties**

**max\_vcpus** `integer`

Maximum CPU count per machine, when constrained.

**max\_memory\_mib** `integer`

Maximum memory per machine in MiB, when constrained.

**starts\_minute** `integer` *required*

Allowed starts in a UTC minute.

**starts\_hour** `integer` *required*

Allowed starts in a UTC hour.

**starts\_day** `integer` *required*

Allowed starts in a UTC day.

**concurrent\_per\_shape** `integer` *required*

Maximum concurrent machines per size.

**saved\_templates** `integer` *required*

Maximum saved templates.

**batch\_size** `integer` *required*

Maximum attempts admitted in one batch.

**burst\_multiple** `integer` *required*

Multiplier for consented burst starts.

**burst\_units** `integer` *required*

Credit units charged per extra start.

**shape\_limits** `object` *required*

Lower concurrency caps keyed by vCPUs-memoryMiB. Additional keys accept `integer` values.

**burst\_enabled** `boolean` *required*

Whether you consented to paid burst starts.

**saved\_templates** `integer` *required*

Current saved template count.

**windows** `object[]` *required*

Start usage in each UTC time window.

**Properties**

**seconds** `integer` *required*

Window duration in seconds.

**usage** `integer` *required*

Starts counted in this window.

**reset\_at** `integer` *required*

Next reset as Unix seconds.

**shapes** `object[]` *required*

Current allocated machines grouped by CPU and memory.

**Properties**

**vcpus** `integer` *required*

CPUs per machine.

**memory\_mib** `integer` *required*

Memory per machine in MiB.

**usage** `integer` *required*

Machines currently allocated with this size.

## Errors

| Status | Meaning |
| - | - |
| 401 | Authentication credential is missing or rejected. |
| 403 | The credential lacks the required scope. |
| 429 | Request or resource admission limit exceeded (`admission_limit`). Follow limit.next\_action and Retry-After when present. |
| 503 | Service or persistence is temporarily unavailable. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.