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

> ## Agent Instructions
> Conare's API is at https://api.conare.ai. Authenticate with `Authorization: Bearer $CONARE_API_KEY`.
> The full OpenAPI spec is at https://api.conare.ai/openapi.yaml; each endpoint has a page under /api-reference, and appending .md to any page URL returns its Markdown.
> Embed with model conare-embed-1; send input_type "query" for search queries. Rerank with conare-rerank-1.
> Prefer the TypeScript SDK (`npm install conare`) or plain HTTP in examples.
> Install the Conare skill with `npx skills add https://docs.conare.ai`; search these docs over MCP at https://docs.conare.ai/mcp; the whole site is at https://docs.conare.ai/llms-full.txt.

# Deep health check

> Checks everything search needs: `ok` or `degraded` (200, still serving), or `down` (503).



## OpenAPI

````yaml /openapi.yaml get /health/deep
openapi: 3.1.0
info:
  title: Conare API
  version: '1'
  summary: Store your data, keep it in sync, and return the right context to your AI.
  description: >
    Write documents into namespaces, search them, and sync apps into them.


    - Base URL `https://api.conare.ai`; send `Authorization: Bearer sk-conare-…`
    (keys at conare.ai/dashboard/keys).

    - A multi-organization key sends `X-Conare-Org: <organization id>` on every
    request (`GET /organizations` lists them).

    - Bodies are JSON in snake_case; an unknown field is 400 `invalid_json`
    (`/v1` and `/v2` ignore it). Errors are `{"error": {"code", "message",
    "request_id"}}`.

    - Send every write with an `Idempotency-Key` and retry with the same key: a
    repeat within 24 hours replays the first answer.

    - 429 and 503 carry `Retry-After` (seconds).

    - `Conare-Degraded` marks a success that skipped or slowed part of search,
    e.g. `rerank` or `embed-busy`.
  contact:
    name: Conare
    url: https://conare.ai
servers:
  - url: https://api.conare.ai
security:
  - apiKey: []
tags:
  - name: Namespaces
    description: >-
      A namespace is a named set of documents, e.g. `docs` or `user-42`; the
      first write creates it.
  - name: Documents
    description: >-
      A document is `{ id, text, metadata }`, chunked and embedded on write;
      writing the same id replaces it.
  - name: Query
    description: >-
      Hybrid search (vector and keyword) over your namespaces, filtered by
      metadata and reranked.
  - name: Models
    description: >-
      Embed and rerank text with Conare's models, through Conare's own routes or
      OpenAI- and Cohere-compatible ones.
  - name: Sources
    description: Apps, buckets and custom sources, each kept in sync into one namespace.
  - name: Custom sources
    description: >-
      Documents you push from your own system, keyed by your `external_id`, with
      snapshot runs to mirror a whole set.
  - name: Parse
    description: Parse a file to Markdown without storing it.
  - name: Files
    description: >-
      Upload a file and Conare stores it as one document, each hit citing its
      page, slide, sheet rows or section.
  - name: Users
    description: >-
      Delete everything Conare holds of one of your users, across every
      namespace and source.
  - name: Events
    description: What changed, in order (`seq`), to read from a cursor.
  - name: Health
    description: Service health.
  - name: Organizations
    description: The organizations a key acts for.
paths:
  /health/deep:
    get:
      tags:
        - Health
      summary: Deep health check
      description: >-
        Checks everything search needs: `ok` or `degraded` (200, still serving),
        or `down` (503).
      operationId: healthDeep
      responses:
        '200':
          description: '`ok` or `degraded`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeepHealth'
        '503':
          description: '`down`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeepHealth'
      security: []
components:
  schemas:
    DeepHealth:
      type: object
      description: Cached for up to a minute. `status` is the verdict.
      required:
        - status
        - checkedAt
      properties:
        status:
          type: string
          enum:
            - ok
            - degraded
            - down
        checkedAt:
          type: string
          format: date-time
          description: When this run started.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: sk-conare-…
      description: >-
        A key from conare.ai/dashboard/keys with full access, some namespaces,
        or models only (`/embed`, `/rerank`, `/v1`, `/v2/rerank`, `/parse`).

````

## Related topics

- [Visão geral da API](https://docs.conare.ai/pt-BR/api.md)
- [Check which documents to push](https://docs.conare.ai/pt-br/api-reference/custom-sources/check-which-documents-to-push.md)
- [Query every namespace](https://docs.conare.ai/pt-br/api-reference/query/query-every-namespace.md)
- [Open a snapshot run](https://docs.conare.ai/pt-br/api-reference/custom-sources/open-a-snapshot-run.md)
- [Google Cloud Storage](https://docs.conare.ai/pt-BR/gcs.md)


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