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

> ## Agent Instructions
> Peel builds APIs from a URL and a task. Use only the REST routes under https://api.peel.sh and the hosted MCP server at https://api.peel.sh/mcp. Authenticate with the X-API-Key header, or send the same key as Authorization: Bearer. Errors carry code, message, retryable, retry, docs_url and details; branch on code. The peel CLI and the open-source SDK are not published; do not run npm install peel, which is an unrelated package. The keyless routes need no key and no session: the GET /public/marketplace routes, POST /v1/marketplace/{marketplace_id}/endpoints/{endpoint_name}:call and https://api.peel.sh/mcp/keyless. Account routes take a key or a signed-in session and answer 401 without one. These take only a session from peel.sh and refuse a key: GET /v1/accounts, POST /v1/accounts/join, POST /v1/accounts/{account_id}/leave, POST /v1/team/invites, GET /v1/connected-apps, DELETE /v1/connected-apps/{client_id}, PUT /v1/logins, DELETE /v1/logins, GET /v1/logins/code and the /account/billing routes. Every route with its schemas is in https://docs.peel.sh/openapi.json. Use the exact route, field and error-code names shown in these pages, and read the API Reference tab for request and response schemas.

# Get quota

> What is left this period and today: runs, builds and the daily run cap, each with its limit and reset time. A null limit means no limit.



## OpenAPI

````yaml /openapi.json get /v1/quota
openapi: 3.1.0
info:
  title: Peel API
  version: 0.1.0
  description: >-
    Public Peel API for creating APIs from URLs, inspecting them, calling
    generated endpoints, revising builds, and exporting OpenAPI or MCP
    definitions.
servers:
  - url: https://api.peel.sh
security: []
tags:
  - name: APIs
    description: Create, list, inspect, revise, rebuild, and export APIs.
  - name: Account
    description: Credits and account usage surfaces used by REST and MCP clients.
  - name: Device Auth
    description: CLI browser-login device flow helpers.
  - name: Endpoint Execution
    description: Execute generated endpoints through a stable API resource.
  - name: OAuth
    description: OAuth discovery and token flows for hosted MCP clients.
  - name: MCP
    description: Hosted MCP transport and discovery surface.
  - name: Marketplace
    description: Discover, install, publish, and explicitly contribute APIs.
  - name: Execution Jobs
    description: Start, reconnect, answer and cancel owner-scoped host executions.
  - name: Runs
    description: >-
      Every call, batch item and execution you ran, with its outcome and its
      requests to the site.
  - name: Files
    description: Encrypted owner-scoped files for declared runtime uploads and downloads.
  - name: Logins
    description: >-
      Saved site logins Peel signs in with for endpoints that need a signed-in
      session.
  - name: Webhooks
    description: Signed Standard Webhooks events for builds and execution jobs.
  - name: Schedules
    description: Run a data endpoint on a schedule and hear when its answer changes.
paths:
  /v1/quota:
    get:
      tags:
        - Account
      summary: Get quota
      description: >-
        What is left this period and today: runs, builds and the daily run cap,
        each with its limit and reset time. A null limit means no limit.
      operationId: getQuota
      responses:
        '200':
          description: Current quota.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quota'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Quota:
      type: object
      required:
        - plan
        - period_end
        - runs
        - builds
        - build_budget
        - daily_runs
        - auto_recharge
        - emails
      properties:
        plan:
          type: string
        period_end:
          type: string
          format: date-time
        runs:
          type: object
          required:
            - limit
            - remaining
            - reset_at
          properties:
            limit:
              oneOf:
                - type: integer
                  minimum: 0
                - type: 'null'
            remaining:
              oneOf:
                - type: integer
                  minimum: 0
                - type: 'null'
            reset_at:
              type: string
              format: date-time
          additionalProperties: false
        builds:
          type: object
          required:
            - limit
            - used
            - remaining
            - reset_at
          properties:
            limit:
              oneOf:
                - type: integer
                  minimum: 0
                - type: 'null'
            used:
              type: integer
              minimum: 0
            remaining:
              oneOf:
                - type: integer
                  minimum: 0
                - type: 'null'
            reset_at:
              type: string
              format: date-time
          additionalProperties: false
        build_budget:
          type: object
          required:
            - limit_usd
            - used_usd
            - remaining_usd
            - reset_at
          properties:
            limit_usd:
              oneOf:
                - type: number
                  minimum: 0
                - type: 'null'
            used_usd:
              type: number
              minimum: 0
            remaining_usd:
              oneOf:
                - type: number
                  minimum: 0
                - type: 'null'
            reset_at:
              type: string
              format: date-time
          additionalProperties: false
          description: >-
            Model spend on builds, revisions and rebuilds this UTC month. At
            limit_usd new ones answer 429 quota_exceeded with details.quota
            build_budget until reset_at; null means no cap.
        daily_runs:
          type: object
          required:
            - limit
            - used
            - reset_at
          properties:
            limit:
              oneOf:
                - type: integer
                  minimum: 0
                - type: 'null'
            used:
              type: integer
              minimum: 0
            reset_at:
              type: string
              format: date-time
          additionalProperties: false
        auto_recharge:
          type: object
          required:
            - enabled
            - monthly_limit
          properties:
            enabled:
              type: boolean
            monthly_limit:
              oneOf:
                - type: integer
                  minimum: 0
                - type: 'null'
          additionalProperties: false
        emails:
          type: object
          required:
            - usage_alerts
            - monthly_summary
          properties:
            usage_alerts:
              type: array
              items:
                type: integer
                minimum: 1
                maximum: 100
            monthly_summary:
              type: boolean
          additionalProperties: false
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
        - type
        - title
        - status
        - instance
        - code
        - message
        - retryable
        - retry
        - docs_url
        - details
      properties:
        type:
          type: string
          format: uri
          description: >-
            RFC 9457 problem type: https://docs.peel.sh/errors/ followed by the
            code.
        title:
          type: string
          description: >-
            Short summary of the problem type. The same for every error with
            this code.
        status:
          type: integer
          minimum: 400
          maximum: 599
          description: The HTTP status of this response.
        instance:
          type: string
          description: >-
            This occurrence: urn:peel:request: followed by the request id, which
            x-request-id also carries.
        code:
          type: string
          description: Stable snake_case error code.
        message:
          type: string
        retryable:
          type: boolean
          description: Whether the same request can succeed later.
        retry:
          type: string
          enum:
            - same_key
            - fix_request
          description: >-
            A request answered with this envelope did not commit a write.
            same_key: send the same request again, with the same
            Idempotency-Key. fix_request: change the request, key or plan first.
        docs_url:
          type: string
          format: uri
        details:
          type: object
          additionalProperties: true
      additionalProperties: false
  responses:
    Unauthorized:
      description: Missing or invalid auth.
      headers:
        WWW-Authenticate:
          schema:
            type: string
          description: OAuth bearer challenge with MCP resource metadata when available.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````

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