> ## 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. # Push documents > Writes up to 100 documents and answers, per document and in order, what the write did. - At most 2 MiB of text in a 16 MiB body; `deleted: true` deletes a document. - With `run_id`, the documents belong to that snapshot run. - On 429, wait `Retry-After` and send the whole push again. ## OpenAPI ````yaml /openapi.yaml put /sources/{id}/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: /sources/{id}/documents: parameters: - $ref: '#/components/parameters/SourceId' put: tags: - Custom sources summary: Push documents description: > Writes up to 100 documents and answers, per document and in order, what the write did. - At most 2 MiB of text in a 16 MiB body; `deleted: true` deletes a document. - With `run_id`, the documents belong to that snapshot run. - On 429, wait `Retry-After` and send the whole push again. operationId: pushDocuments requestBody: required: true content: application/json: schema: type: object required: - documents properties: run_id: type: string description: An open snapshot run of this source. documents: type: array minItems: 1 maxItems: 100 items: $ref: '#/components/schemas/CustomDocumentInput' example: documents: - external_id: ticket-1042 text: Refunds take 5 days. seq: 1730000000000 tag: etag-9 responses: '200': description: One result per document. content: application/json: schema: type: object required: - results properties: results: type: array items: $ref: '#/components/schemas/PushResult' '400': $ref: '#/components/responses/Error' '401': $ref: '#/components/responses/Error' '404': $ref: '#/components/responses/Error' '409': $ref: '#/components/responses/Error' '413': $ref: '#/components/responses/Error' '429': $ref: '#/components/responses/Error' '503': $ref: '#/components/responses/Error' components: parameters: SourceId: name: id in: path required: true description: The source id, `src_…`. schema: type: string schemas: CustomDocumentInput: type: object required: - external_id properties: external_id: type: string description: Your id for the document; its `key` is derived from it. text: type: string description: >- Of any length within the push's 2 MiB of text (an import line's 64 MiB); a long text is stored in parts and searched as one document. title: type: string url: type: string event_at: type: string format: date-time metadata: $ref: '#/components/schemas/Metadata' user: $ref: '#/components/schemas/User' seq: type: integer format: int64 minimum: 0 description: >- Orders your versions of the document (and its deletes); a lower one than stored is `stale`. tag: type: string description: 'Your version tag (an etag, a hash): `check` compares it.' deleted: type: boolean default: false PushResult: type: object required: - external_id - key - result properties: external_id: type: string key: type: string result: type: string enum: - created - updated - unchanged - stale - deleted - rejected code: type: string description: >- With `rejected`: `too_large`, `invalid`, `invalid_metadata`, `excluded`, `user_purging`, `source_deleting`. message: type: string seq: type: integer format: int64 stored_seq: type: integer format: int64 description: 'With `stale`: the seq Conare holds (or its delete''s).' version: type: integer format: int64 chunks: type: integer chunks_embedded: type: integer 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 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 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 - [Check which documents to push](https://docs.conare.ai/uk/api-reference/custom-sources/check-which-documents-to-push.md) - [Restore excluded documents](https://docs.conare.ai/uk/api-reference/custom-sources/restore-excluded-documents.md) - [Delete a source's documents](https://docs.conare.ai/uk/api-reference/custom-sources/delete-a-sources-documents.md) - [Disconnect a source](https://docs.conare.ai/uk/api-reference/sources/disconnect-a-source.md) - [Import an upload](https://docs.conare.ai/uk/api-reference/custom-sources/import-an-upload.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.