> ## 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. # Add documents > Writes 1-100 documents. One with an existing id replaces it; the first write creates the namespace. - `results` says per document what happened; an `unchanged` one is not embedded again. - `if_version` writes only at that version (`0`: only if new), else 409; a lower `seq` than stored is `stale`. - A batch is not atomic; with `Idempotency-Key`, a document without an id gets the same id on every retry. ## OpenAPI ````yaml /openapi.yaml post /namespaces/{namespace}/documents 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: ` 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: /namespaces/{namespace}/documents: parameters: - $ref: '#/components/parameters/Namespace' post: tags: - Documents summary: Add documents description: > Writes 1-100 documents. One with an existing id replaces it; the first write creates the namespace. - `results` says per document what happened; an `unchanged` one is not embedded again. - `if_version` writes only at that version (`0`: only if new), else 409; a lower `seq` than stored is `stale`. - A batch is not atomic; with `Idempotency-Key`, a document without an id gets the same id on every retry. operationId: addDocuments parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object required: - documents properties: documents: type: array minItems: 1 maxItems: 100 description: >- The documents, each `id` once; the body is at most 32 MiB (33,554,432 bytes). items: $ref: '#/components/schemas/DocumentInput' example: documents: - id: refunds text: Refunds are available for 30 days after purchase. metadata: team: support year: 2025 responses: '200': description: The documents' ids, versions and results, in request order. headers: Conare-Degraded: $ref: '#/components/headers/ConareDegraded' Conare-Embed-Busy-Ms: $ref: '#/components/headers/ConareEmbedBusyMs' Idempotent-Replayed: $ref: '#/components/headers/IdempotentReplayed' content: application/json: schema: type: object required: - ids - versions - results properties: ids: type: array items: type: string versions: type: array items: $ref: '#/components/schemas/DocumentVersion' results: type: array items: $ref: '#/components/schemas/WriteResult' example: ids: - refunds versions: - 1042 results: - id: refunds result: updated version: 1042 chunks: 1 chunks_embedded: 0 '400': $ref: '#/components/responses/Error' '401': $ref: '#/components/responses/Error' '409': description: >- `version_conflict`: `if_version` didn't match. `conflict`: concurrent write; retry. `idempotency_in_progress`: the call with this `Idempotency-Key` is still running; retry. content: application/json: schema: $ref: '#/components/schemas/Error' '413': $ref: '#/components/responses/Error' '422': $ref: '#/components/responses/Error' '429': $ref: '#/components/responses/Error' '503': $ref: '#/components/responses/Error' components: parameters: Namespace: name: namespace in: path required: true description: The namespace name. schema: $ref: '#/components/schemas/NamespaceName' IdempotencyKey: name: Idempotency-Key in: header required: false description: >- One key (a UUID) per logical write, sent again on each retry: a repeat within 24 hours replays the first successful answer. schema: type: string minLength: 1 maxLength: 255 pattern: ^[\x21-\x7e]+$ example: 3f2c9a0e-6a1b-4f7e-9c55-0b8f1d2e7a41 schemas: DocumentInput: type: object required: - text properties: id: $ref: '#/components/schemas/DocumentId' description: Omit to have Conare generate one; `""` or `null` is 400. text: type: string minLength: 1 description: >- The document text, of any length within the write's 32 MiB body. A long text is stored in parts and searched, read and deleted as one document. metadata: $ref: '#/components/schemas/Metadata' if_version: type: integer format: int64 minimum: 0 description: >- Write only if the document is at this version (`0`: only if it does not exist), else 409. user: $ref: '#/components/schemas/User' description: >- The user of yours it belongs to: a tag for filters and `DELETE /users`, not an access control. seq: type: integer format: int64 minimum: 0 maximum: 9007199254740992 description: >- Your sequence number (e.g. a source timestamp); a write with a lower `seq` than stored is `stale`. DocumentVersion: type: integer format: int64 minimum: 1 description: >- Changes on every write that stores something new; compare for equality only. WriteResult: type: object required: - id - result - version - chunks - chunks_embedded properties: id: $ref: '#/components/schemas/DocumentId' result: type: string enum: - created - updated - unchanged - stale description: >- `unchanged`: already held as sent, nothing embedded. `stale`: a higher `seq` is stored (`stored_seq`). version: $ref: '#/components/schemas/DocumentVersion' chunks: type: integer description: The document's passages. chunks_embedded: type: integer description: The passages this write embedded. stored_seq: type: integer format: int64 description: With `stale`, the `seq` Conare holds. Error: type: object required: - error properties: error: type: object required: - code - message - request_id properties: code: type: string description: > Stable, machine-readable, by status: - 400: `invalid_request`, `fetch_failed`, `invalid_json`, `invalid_namespace`, `invalid_id`, `invalid_metadata`, `invalid_filter`, `invalid_cursor`, `invalid`, `md5_mismatch`, `idempotency_key_required`, `invalid_path` - 401: `unauthorized`, `invalid_upload` - 402 (billed calls only): `credits_exhausted`, `spend_cap_reached`, `monthly_limit_reached`, `payment_failed` - 403: `forbidden`, `namespace_forbidden`, `key_scope_models_only`, `namespace_not_allowed` - 404: `namespace_not_found`, `document_not_found`, `source_not_found`, `model_not_found`, `key_not_found`, `file_not_found`, `parse_not_found`, `not_found` - 405: `method_not_allowed` - 409: `version_conflict`, `conflict`, `idempotency_in_progress`, `run_active`, `run_not_receiving`, `source_deleting`, `user_purging`, `upload_incomplete`, `namespace_has_sources`, `too_many_exclusions`, `push_source`, `pull_source`, `files_source`, `no_original`, `file_replaced`, `gcs_bucket_claimed`, `limit_reached` - 410: `upload_expired`, `model_retired` - 413: `payload_too_large`, `too_large` - 415: `unsupported_file`, `type_mismatch`, `unsupported_encoding` - 422: `idempotency_key_reused`, `no_text`, `unreadable_file`, `password_protected`, `gcs_access_denied`, `gcs_not_verified`, `gcs_bucket_not_found` - 429: `rate_limited` - 500: `internal_error`; 502: `upstream_error`; 501: `models_only` - 503: `unavailable`, `sources_unavailable`, `timeout`, `embed_unavailable`, `sync_storage_unavailable`, `sync_unconfigured`, `files_unconfigured`, `files_unavailable`, `gcs_unconfigured`, `gcs_unavailable`, `gcs_auth_failed` message: type: string request_id: type: string NamespaceName: type: string pattern: ^[a-z0-9][a-z0-9_-]{0,63}$ description: 1-64 characters of `a-z 0-9 _ -`, starting with a letter or digit. examples: - docs - user-42 DocumentId: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$ description: >- 1-256 characters of `A-Z a-z 0-9 . _ : -`, starting with a letter or digit. examples: - refunds - hubspot:contacts:1042 Metadata: type: object maxProperties: 32 description: > Strings, numbers, booleans or string arrays, for filtering; else 400 `invalid_metadata`. - At most 256 indexed values: an array item or a boolean counts one, a number or a string up to 222 bytes two. propertyNames: pattern: ^[A-Za-z][A-Za-z0-9_.-]{0,63}$ not: enum: - id - text - vector - ttl_at_ms additionalProperties: oneOf: - type: string maxLength: 4096 description: At most 4,096 bytes of UTF-8. - type: number description: Within a 64-bit float's range (`1e309` is 400 `invalid_metadata`). - type: boolean - type: array maxItems: 256 items: type: string maxLength: 4096 description: At most 4,096 bytes of UTF-8. User: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9._:@-]{0,127}$ description: >- A user id of yours, with at most 8 `:`; group users with `:` (`tenant-7:u_42`) and query a group by `user_prefix`. examples: - tenant-7:u_42 headers: ConareDegraded: description: > Set when a request succeeded without part of search, or slower; comma-separated values: - `rerank`: results not reranked. `rerank-partial`: the rerank partly finished under load; usable, and a retry adds load. - `embed`: no vector retrieval. `embed-busy`: waited on a full embedding queue (`Conare-Embed-Busy-Ms`). `embed-fallback`: a backup served identical vectors. - `keyword`: no keyword retrieval. `keyword-terms`: keyword retrieval read only a long query's first words. - `cursor`: a paged search's first page came without `next_cursor`; search again for the rest. - `answer`: the answer model was unavailable; results only. schema: type: string example: rerank,embed-fallback ConareEmbedBusyMs: description: >- With `Conare-Degraded: embed-busy`, the milliseconds spent waiting; on writes, lower your concurrency until it goes away. schema: type: integer minimum: 1 example: 8400 IdempotentReplayed: description: >- `true` on an answer replayed for a repeated `Idempotency-Key`: the call did nothing again. schema: type: string enum: - 'true' responses: Error: description: An error. `X-Request-Id` is also in the response headers. headers: X-Request-Id: schema: type: string Retry-After: description: Seconds to wait before retrying (429, 503). schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: invalid_request message: text is required request_id: 7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04 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 - [TypeScript SDK](https://docs.conare.ai/ar/sdk.md) - [Rerank documents (Cohere- and vLLM-compatible)](https://docs.conare.ai/ar/api-reference/models/rerank-documents-cohere-and-vllm-compatible.md) - [Rerank documents (Cohere v2-compatible)](https://docs.conare.ai/ar/api-reference/models/rerank-documents-cohere-v2-compatible.md) - [Push documents](https://docs.conare.ai/ar/api-reference/custom-sources/push-documents.md) - [Rerank documents](https://docs.conare.ai/ar/api-reference/models/rerank-documents.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.