> ## Documentation Index > Fetch the complete documentation index at: https://docs.boat.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get Boat limits > Check remaining machine starts, compute time, credits, access readiness, and concurrent-sandbox capacity for the wallet a create would bill: the `org` / `X-Boat-Org` you pass (id or name), else the account's active wallet, else personal. The response carries `teamId` when an organization wallet was read. ## OpenAPI ````yaml openapi/boat-v1.yaml GET /limits openapi: 3.1.0 info: title: Boat Public API v1 version: 1.0.0 description: > Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products. The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. servers: - url: https://boat.dev/api/v1 security: - BoatBearerAuth: [] tags: - name: Boat description: >- Unified Boat account, setup, lifecycle, prompting, event history, desktop access, and SSH operations. paths: /limits: get: tags: - Boat summary: Get Boat limits description: >- Check remaining machine starts, compute time, credits, access readiness, and concurrent-sandbox capacity for the wallet a create would bill: the `org` / `X-Boat-Org` you pass (id or name), else the account's active wallet, else personal. The response carries `teamId` when an organization wallet was read. operationId: limits parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/OrgHeader' - name: teamId in: query required: false schema: type: string description: >- Legacy alias for `org`. Takes precedence over `org` / `X-Boat-Org` when set. responses: '200': description: Current creation and concurrent-boat limits. content: application/json: schema: $ref: '#/components/schemas/LimitsResponse' examples: ready: value: ok: true type: limits.info canStart: true activeSandboxes: 1 activeStates: - provisioned - cloning - ready - idle - running sandboxPlanKey: box_20 sandboxPlanDollars: 20 maxActiveSandboxes: 100 maxCreationRequestsPerMinute: 10 maxCreationRequestsPerDay: null startLimits: perMinute: 10 perHour: 50 perDay: 150 starts: unlimited: false minute: limit: 10 used: 3 remaining: 7 hour: limit: 50 used: 12 remaining: 38 day: limit: 150 used: 47 remaining: 103 billingStatus: active creditBalanceSeconds: 7200 creditBalanceHours: 2 packBalanceSeconds: 500000 packBalanceHours: 138.89 packBalanceDollars: 5 '401': $ref: '#/components/responses/Unauthorized' components: parameters: OrgId: name: org in: query required: false schema: type: string description: >- Billing wallet for this request: an organization you belong to, by id (`team_…`) or by name as `GET /orgs` lists it (case-insensitive), or `personal`. Omitted, the account's active wallet applies (`PATCH /orgs/active`; personal until set). Two organizations sharing the name answer `409 ambiguous_org` and need the id. Sandboxes, snapshots, and environments stay creator-private. OrgHeader: name: X-Boat-Org in: header required: false schema: type: string description: Same as the `org` query parameter. Query wins when both are set. schemas: LimitsResponse: allOf: - $ref: '#/components/schemas/SuccessBase' - $ref: '#/components/schemas/LimitsFields' SuccessBase: type: object required: - ok - type properties: ok: type: boolean examples: - true type: type: string description: Stable success envelope discriminator added by v1. LimitsFields: type: object required: - activeSandboxes - maxActiveSandboxes - canStart - billingStatus additionalProperties: true properties: accessTier: type: string examples: - trial blockedReason: type: - string - 'null' currentLimits: type: object additionalProperties: true properties: activeSandboxes: type: integer creationRatePerMinute: type: integer creationRequestsPerHour: type: - integer - 'null' creationRequestsPerDay: type: - integer - 'null' standardLimits: type: object additionalProperties: true properties: activeSandboxes: type: integer creationRatePerMinute: type: integer creationRequestsPerHour: type: - integer - 'null' creationRequestsPerDay: type: - integer - 'null' trialLimits: type: object additionalProperties: true properties: activeSandboxes: type: integer creationRatePerMinute: type: integer creationRequestsPerHour: type: - integer - 'null' creationRequestsPerDay: type: - integer - 'null' upgradeEffects: type: object additionalProperties: true canStart: type: boolean description: >- Whether the authenticated account can create or operate sandboxes right now. checkoutRequired: type: boolean startBlockedReason: type: - string - 'null' contactMessage: type: - string - 'null' activeSandboxes: type: integer activeStates: type: array items: type: string maxActiveSandboxes: type: integer maxCreationRequestsPerMinute: type: integer maxCreationRequestsPerDay: type: - integer - 'null' startLimits: type: - object - 'null' description: >- Plan caps for machine starts. Null on unlimited accounts. Create, fork and resume each count as one start. properties: perMinute: type: integer perHour: type: integer perDay: type: integer starts: type: object description: >- Remaining machine starts in the rolling minute, hour and day windows. Null windows mean the account is unlimited. properties: unlimited: type: boolean minute: $ref: '#/components/schemas/StartWindowUsage' hour: $ref: '#/components/schemas/StartWindowUsage' day: $ref: '#/components/schemas/StartWindowUsage' creditBalanceHours: type: - number - 'null' description: >- Remaining machine time in hours (`creditBalanceSeconds / 3600`). Null on unlimited accounts. packBalanceHours: type: number description: Remaining purchased credit packs in hours. packBalanceDollars: type: number description: Remaining purchased credit packs in dollars. hasPaymentHistory: type: boolean package: type: object additionalProperties: true subscriptionQuotaSeconds: type: integer subscriptionRemainingSeconds: type: integer packBalanceSeconds: type: integer creditPurchasedSeconds: type: integer creditUsedSeconds: type: integer liveUsageSeconds: type: integer creditSecondsPerDollar: type: integer sandboxPlanKey: type: string description: Current plan key, or `trial` before any payment. examples: - box_20 sandboxPlanDollars: type: number description: Monthly price of the current plan in dollars. sandboxPlanTiers: type: array description: Every plan tier and its limits. items: type: object properties: key: type: string examples: - box_20 dollars: type: number displayPrice: type: string examples: - $20/mo maxActiveSandboxes: type: integer startsPerMinute: type: integer startsPerHour: type: integer startsPerDay: type: integer includedSeconds: type: integer description: Machine time included each month. purchasable: type: boolean description: Whether this tier can be bought right now. accountPlan: type: string examples: - user - service plan: type: - string - 'null' description: '`service` for service accounts, otherwise null.' planName: type: - string - 'null' description: '`Service` for service accounts, otherwise null.' serviceAccount: type: boolean unlimited: type: boolean description: True when the account has no machine-time or start limits. hasSeatPlan: type: boolean description: True when an organization has an active per-seat plan. last24hUsageSeconds: type: integer description: >- Machine time used in the last 24 hours, in seconds. Useful to estimate how long the balance lasts. trialComputeCapSeconds: type: - integer - 'null' description: >- Lifetime machine-time allowance for a trial that never paid. Null once the account has paid or has a plan. trialLine: type: - string - 'null' description: The trial limits in one readable line. Null on paid accounts. giftLimit: type: - object - 'null' description: Fair-use caps on a gifted account, or null when there are none. properties: maxActiveSandboxes: type: - integer - 'null' maxTtlSeconds: type: - integer - 'null' line: type: - string - 'null' description: The caps in one readable line. message: type: string description: The same text shown when a cap is hit. billingStatus: type: string description: >- Account access state returned by the current backend. Billing endpoints are not part of v1. subscriptionStatus: type: - string - 'null' subscriptionCancelAtPeriodEnd: type: boolean hasSubscription: type: boolean subscriptionTrialEndsAt: type: - string - 'null' format: date-time subscriptionCurrentPeriodEnd: type: - string - 'null' format: date-time creditBalanceSeconds: type: integer teamId: type: string description: >- Present when limits were read for a team wallet (`?teamId=`, `?org=`, or `X-Boat-Org`). teamRole: type: string description: Caller's role on that team when `teamId` is present. ErrorEnvelope: type: object required: - ok - type - status - code - message - error - requestId properties: ok: type: boolean examples: - false type: type: string examples: - sandbox.error status: type: integer examples: - 409 code: type: string examples: - provider_not_configured message: type: string examples: - Prompting is locked until Codex is configured on the Agents page. requestId: type: string examples: - req_01HX... error: type: object required: - code - message - status properties: code: type: string message: type: string status: type: integer details: type: object additionalProperties: true StartWindowUsage: type: - object - 'null' description: One rolling start window. Null when the account is unlimited. properties: limit: type: integer used: type: integer remaining: type: integer responses: Unauthorized: description: Missing or invalid bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: unauthorized: value: ok: false type: sandbox.error status: 401 code: unauthorized message: Unauthorized error: code: unauthorized message: Unauthorized status: 401 requestId: req_01HX... securitySchemes: BoatBearerAuth: type: http scheme: bearer bearerFormat: sandbox_api_key description: >- Boat bearer token in the form `boat_...`. Service API keys authenticate sandbox operations. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.