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

# Limits

> See your plan, balance, rate limit and key expiry. Send one request and get JSON back. Examples in cURL, TypeScript and Python.

Free. Counts as one call toward the per-minute rate limit. Needs an API key: without one the answer is 401, and the keyless limits are 10 requests a minute and 50 a day per IP.

```bash cURL theme={null}
curl https://api.stophy.dev/v1/limits \
  -H "Authorization: Bearer $STOPHY_API_KEY"
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/limits", {
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
  },
});
console.log(await response.json());
```

```python Python theme={null}
import os

import requests

response = requests.get(
    "https://api.stophy.dev/v1/limits",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
)
print(response.json())
```

```json 200 theme={null}
{
  "success": true,
  "data": {
    "tier": "paid",
    "balanceCredits": 5000,
    "rateLimit": {
      "limitPerMinute": 600,
      "remaining": 596,
      "resetsAt": "2026-11-05T23:37:00.000Z"
    },
    "keyExpiresAt": null,
    "billingUrl": "https://stophy.dev/billing"
  },
  "creditsUsed": 0,
  "requestId": "6d66e7cf-66c5-406e-b382-536aedbd026a"
}
```


## OpenAPI

````yaml api-reference/openapi.json GET /v1/limits
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Every endpoint is a POST that takes its input as a JSON object body. Unknown
    fields are rejected with 400.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    Text comes back whole. To get shorter responses, add
    ?maxTextLength=<characters> to the URL. Every text value longer than that is
    cut and ends with …. A screenshot is never cut, and a page whose text was
    cut has isTruncated set to true.


    x-credits is what one call costs. Every call costs the same, whatever it
    returns, unless an operation's description says it costs per 10 results, or
    per second of audio. Then x-credits is the lowest price and x-credits-max
    the most one call can cost. Where an operation takes limit, send it to
    return fewer results and pay for fewer.


    When a response has a cursor, send it back unchanged with the same input to
    get the next page. When it has a page, send the next page number.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/limits:
    get:
      summary: See your plan, balance, rate limit and key expiry.
      description: >-
        Free. Counts as one call toward the per-minute rate limit. Needs an API
        key: without one the answer is 401, and the keyless limits are 10
        requests a minute and 50 a day per IP.
      operationId: getLimits
      responses:
        '200':
          description: Your limits.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    required:
                      - tier
                      - balanceCredits
                      - rateLimit
                      - keyExpiresAt
                      - billingUrl
                    properties:
                      tier:
                        type: string
                        enum:
                          - free
                          - paid
                        description: paid once the account has topped up, free before that.
                      balanceCredits:
                        type: number
                        description: Credits left on the account.
                      rateLimit:
                        type:
                          - object
                          - 'null'
                        description: >-
                          Calls allowed per minute with this key and how many
                          are left, counting this request. Null when the counter
                          is unavailable.
                        properties:
                          limitPerMinute:
                            type: integer
                          remaining:
                            type: integer
                          resetsAt:
                            type: string
                            format: date-time
                      keyExpiresAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: >-
                          When this key stops working. Null when it does not
                          expire.
                      billingUrl:
                        type: string
                        const: https://stophy.dev/billing
                        description: Where a person adds credits.
                  creditsUsed:
                    type: integer
                    const: 0
                  requestId:
                    type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time in seconds when the current window resets.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. Retry-After says when trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          const: false
        error:
          type: string
          description: What went wrong and what to do next.
        code:
          type: string
          enum:
            - apiKeyRequired
            - cliSessionCompleted
            - cliSessionExists
            - cliSessionNotFound
            - forbidden
            - freeLimit
            - insufficientCredits
            - internalError
            - inviteClaimed
            - inviteDisabled
            - inviteExpired
            - inviteUsedUp
            - invalidCliSession
            - invalidCliVerifier
            - invalidRequest
            - jobFinished
            - methodNotAllowed
            - notFound
            - payloadTooLarge
            - profileBusy
            - profileTooLarge
            - rateLimited
            - sourceChanged
            - sourceRefused
            - siteNotRead
            - sourceTimeout
            - sourceUnavailable
            - unauthorized
            - unsupportedMediaType
        retryAfterSeconds:
          type: integer
        signupUrl:
          type: string
          const: https://stophy.dev/signup
          description: >-
            Where a person gets a key. Sent with apiKeyRequired, freeLimit and
            an invalid key.
        signup:
          type: string
          const: POST https://api.stophy.dev/v1/signup
          description: >-
            The call that gets an agent a key with no human. Sent next to
            signupUrl.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

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