> ## 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.

# API-Übersicht

> Basis-URL, Authentifizierung, Fehler, Wiederholungen, Rate-Limits und Header der Conare API.

Die Conare API ist JSON über HTTPS. Jeder Endpunkt hat in diesem Tab eine Seite mit einem Playground.

| | |
| - | - |
| Basis-URL | `https://api.conare.ai` |
| Auth | `Authorization: Bearer $CONARE_API_KEY` |
| Schlüssel | Werden in der [Konsole](https://docs.conare.ai/de/console.md#schlüssel) erstellt; bewahren Sie sie auf Ihrem Server auf |
| Bodys | JSON, snake\_case; unbekannte Felder ergeben `400` |
| Spezifikation | [api.conare.ai/openapi.yaml](https://api.conare.ai/openapi.yaml) |

```bash theme={null}
curl https://api.conare.ai/namespaces \
  -H "Authorization: Bearer $CONARE_API_KEY"
```

Die OpenAI- und Cohere-kompatiblen Routen (`/v1`, `/v2`) ignorieren unbekannte Felder.

## Fehler

```json theme={null}
{
  "error": {
    "code": "invalid_request",
    "message": "documents[0].text is required",
    "request_id": "45ea7c7353368cb646e5cc2303008072"
  }
}
```

| Status | Bedeutung |
| - | - |
| 400 | Die Anfrage ist ungültig; `message` nennt den Grund |
| 401 | Der Schlüssel fehlt, ist falsch oder widerrufen |
| 403 | Der Schlüssel hat keinen Zugriff auf diesen Namespace oder diese Route |
| 404 | Nicht gefunden |
| 409 | Ein Versionskonflikt, oder ein gleichzeitiger Schreibvorgang hat gewonnen |
| 413 | Der Body, ein Dokument oder eine Datei ist zu groß |
| 415 | Der [Dateityp](https://docs.conare.ai/de/files.md) wird nicht unterstützt |
| 422 | Die Datei kann nicht gelesen werden, oder ein `Idempotency-Key` wurde für eine andere Anfrage wiederverwendet |
| 429 | Über einem [Rate-Limit](#rate-limits) |
| 5xx | Ein Problem auf unserer Seite |

## Wiederholungen

| Fall | Vorgehen |
| - | - |
| `429`, `503` | Nach den Sekunden im Header `Retry-After` wiederholen |
| Andere 5xx | Mit Backoff wiederholen |
| Schreib- und Löschvorgänge | Senden Sie einen `Idempotency-Key` (eine UUID); eine Wiederholung innerhalb von 24 Stunden liefert die erste Antwort mit `Idempotent-Replayed: true` und ändert nichts |

Das [SDK](https://docs.conare.ai/de/sdk.md) wiederholt Anfragen und sendet `Idempotency-Key` für Sie.

## Rate-Limits

Pro Organisation. Lastspitzen im Umfang von bis zu 10 Sekunden sind in Ordnung; über einem Limit gibt die API `429` mit `Retry-After` zurück.

| Aufrufe | Pro Sekunde | Gleichzeitig in Bearbeitung |
| - | - | - |
| Suche | 100 | 128 |
| Schreiben | 100 Dokumente | 64 |
| Embed | 100 Texte | 16 |
| Rerank | 20 | 16 |
| [turbopuffer API](https://docs.conare.ai/de/turbopuffer.md)-Abfragen | 1.000 | |
| Alles andere | 100 | |

## Header

| Header | Richtung | Bedeutung |
| - | - | - |
| `Authorization` | Anfrage | `Bearer` und Ihr Schlüssel |
| `Idempotency-Key` | Anfrage | Macht einen Schreibvorgang sicher wiederholbar |
| `X-Conare-Org` | Anfrage | Die Organisation, für die gehandelt wird, bei einem Schlüssel für mehrere Organisationen ([auflisten](https://docs.conare.ai/de/api-reference/organizations/list-organizations.md)) |
| `Content-Encoding: gzip` | Anfrage | Ein komprimierter Body; Limits zählen ihn dekomprimiert |
| `X-Request-Id` | Antwort | In jeder Antwort; geben Sie sie an, wenn Sie den Support kontaktieren |
| `Retry-After` | Antwort | Wartezeit in Sekunden, bei `429` und `503` |
| `Conare-Degraded` | Antwort | Die Anfrage war erfolgreich, aber ohne einen Teil ihrer Arbeit, etwa das Reranking ([Werte](https://docs.conare.ai/de/query.md#eingeschränkte-ergebnisse)) |
| `Idempotent-Replayed` | Antwort | `true`, wenn eine Wiederholung die erste Antwort erhalten hat |

## Status

`GET /health/deep` benötigt keinen Schlüssel: `status` ist `ok`, `degraded` (beide HTTP 200) oder `down` (HTTP 503).

```json Response theme={null}
{ "status": "ok", "checkedAt": "2026-10-21T21:39:16.729996745Z" }
```


## Related topics

- [turbopuffer API](https://docs.conare.ai/de/turbopuffer.md)
- [Embed texts (OpenAI-compatible)](https://docs.conare.ai/de/api-reference/models/embed-texts-openai-compatible.md)
- [Connect a source](https://docs.conare.ai/de/api-reference/sources/connect-a-source.md)
- [Rerank documents (Cohere- and vLLM-compatible)](https://docs.conare.ai/de/api-reference/models/rerank-documents-cohere-and-vllm-compatible.md)
- [Rerank documents (Cohere v2-compatible)](https://docs.conare.ai/de/api-reference/models/rerank-documents-cohere-v2-compatible.md)


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