> ## 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 /health

> Check that the Prefetch API is up. No API key needed, and free.

Returns `200` with `{"status": "ok"}` while the API is running. It needs no API key and costs nothing, so you can point your own uptime monitoring at it.

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

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

For incidents and uptime history, see the [status page](https://prefetch.betteruptime.com/). For a check that also confirms Prefetch can accept background jobs, use [`GET /ready`](https://docs.prefetch.io/api-reference/endpoint/ready).


## OpenAPI

````yaml GET /health
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:
  /health:
    get:
      tags:
        - Health
      summary: Liveness check
      description: >-
        Returns HTTP 200 if the server process is alive. No authentication
        required.
      operationId: getHealth
      responses:
        '200':
          description: Server is alive.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - ok
                    example: ok
                  uptime:
                    type: integer
                    example: 3600
                  pid:
                    type: integer
      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.