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

# GET /ready

> Check that the Prefetch API can accept requests and background jobs. No API key needed, and free.

Returns `200` when the API is ready to handle requests, including the queue that runs crawls, batches and monitor checks. It returns `503` when that queue is unavailable. It needs no API key and costs nothing.

```bash theme={"theme":"css-variables"}
curl https://api.prefetch.io/ready
```

```json 200 Ready theme={"theme":"css-variables"}
{ "status": "ok" }
```

```json 503 Not ready theme={"theme":"css-variables"}
{ "status": "error", "message": "Redis connection failed" }
```

To check only that the API is running, use [`GET /health`](https://docs.prefetch.io/api-reference/endpoint/health).


## OpenAPI

````yaml GET /ready
openapi: 3.1.0
info:
  title: Prefetch API
  description: >-
    Extract brand identity, company data, screenshots, IAB classifications, and
    clean page content from any URL.
  version: 1.0.0
  contact:
    email: support@prefetch.io
servers:
  - url: https://api.prefetch.io
    description: Production
security:
  - apiKey: []
tags:
  - name: Endpoints
    description: Data extraction endpoints. All require authentication and consume credits.
  - name: Health
    description: Health and readiness probes. No authentication required.
paths:
  /ready:
    get:
      tags:
        - Health
      summary: Readiness check
      description: >-
        Returns HTTP 200 if the server is ready to handle requests. Returns HTTP
        503 if a dependency is unavailable.
      operationId: getReady
      responses:
        '200':
          description: Server is ready.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - ready
                      - degraded
                    example: ready
                  checks:
                    type: object
                    properties:
                      redis:
                        type: string
                        example: ok
        '503':
          description: Server is not ready.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - degraded
                  checks:
                    type: object
                    properties:
                      redis:
                        type: string
                        example: error
      security: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your Prefetch API key. Obtain one from the dashboard.

````

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