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

# GET /health

> Liveness probe for the DEX Aggregator API.

Returns `{ "ok": true }` when the service is reachable. No authentication required.

<Info>
  This endpoint is **public** — it does not require an `x-api-key` header.
</Info>

## Request

```http theme={null} theme={null}
GET {API_URL}/health
```

## Response

```json theme={null} theme={null}
{ "ok": true }
```

## When to use this

<CardGroup cols={2}>
  <Card title="CI / monitoring" icon="heart-pulse">
    Schedule periodic health checks from your monitoring system. Treat anything other than `200 { "ok": true }` as down.
  </Card>

  <Card title="Connectivity self-test" icon="plug">
    Use as the first call in an integration test to confirm DNS, TLS, and API key plumbing without spending quota on a real quote.
  </Card>
</CardGroup>

```bash theme={null} theme={null}
curl https://quiet-bloodhound-531.convex.site/health
```


## OpenAPI

````yaml openapi.yaml GET /health
openapi: 3.1.0
info:
  title: o1 DEX Aggregator API
  version: 0.1.0
  description: |
    Quote + execution API for the o1 DEX aggregator on Base.

    Flow:
      1. POST /quote   → returns quoteId + routePlan
      2. POST /submit  → returns the calldata payload to broadcast
      3. Caller signs and broadcasts O1Router.swapExactIn().

    /execute is a one-shot convenience that combines /quote and /submit.

    All non-`/health` endpoints require the `x-api-key` header. Rate limit
    defaults to 120 requests per minute per client IP.
servers:
  - url: https://quiet-bloodhound-531.convex.site
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: meta
    description: Liveness and version probes.
  - name: quote
    description: Pricing endpoints that produce a routePlan.
  - name: submit
    description: Calldata builders that turn a quote into a broadcast-ready transaction.
  - name: aggregator-comparison
    description: >-
      Optional endpoints that fan out to upstream aggregators (0x / 1inch /
      KyberSwap / Relay / Odos / CoW). Mounted only when at least one upstream
      adapter is configured server-side.
paths:
  /health:
    get:
      tags:
        - meta
      summary: Liveness probe
      operationId: getHealth
      responses:
        '200':
          description: Service is up
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                properties:
                  ok:
                    type: boolean
                    const: true
      security: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````