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

# 快速入门

> 获取 Conare API 密钥，使用 curl 或 TypeScript SDK 向命名空间写入第一个文档，然后搜索它并将结果传给您的模型。

**1. 获取密钥**

在[控制台](https://conare.ai/dashboard/keys)中创建 API 密钥。访问需要邀请：[申请访问](https://conare.ai/request-access)。

```bash theme={null}
export CONARE_API_KEY=sk-conare-...
npm install conare  # for the TypeScript examples
```

**2. 写入文档**

首次写入会创建命名空间 `docs`。

```bash curl theme={null}
curl https://api.conare.ai/namespaces/docs/documents \
  -H "Authorization: Bearer $CONARE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "documents": [
      { "id": "refunds", "text": "Refunds are available for 30 days.", "metadata": { "team": "support" } }
    ]
  }'
```

```ts TypeScript theme={null}
import { Conare } from "conare";

const conare = new Conare();
const docs = conare.namespace("docs");

await docs.add({ id: "refunds", text: "Refunds are available for 30 days.", metadata: { team: "support" } });
```

**3. 搜索**

```bash curl theme={null}
curl https://api.conare.ai/namespaces/docs/query \
  -H "Authorization: Bearer $CONARE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "how do refunds work?"}'
```

```ts TypeScript theme={null}
const results = await docs.query("how do refunds work?");
```

```json Response theme={null}
{
  "results": [
    {
      "id": "refunds",
      "text": "Refunds are available for 30 days.",
      "score": 0.3471,
      "reranked": true,
      "metadata": { "team": "support" }
    }
  ],
  "took_ms": 59
}
```

将每个结果的 `text` 作为上下文传给您的模型。

## 下一步

| 指南 | 用途 |
| - | - |
| [MCP](https://docs.conare.ai/zh/mcp-server.md) | 从 Claude、Cursor 或 ChatGPT 中搜索 |
| [过滤器](https://docs.conare.ai/zh/filters.md) | 按元数据缩小搜索范围 |
| [文件](https://docs.conare.ai/zh/files.md) | 上传 PDF、演示文稿和电子表格 |
| [数据源](https://docs.conare.ai/zh/sources.md) | 让应用保持同步 |


## Related topics

- [简介](https://docs.conare.ai/zh/index.md)
- [MCP](https://docs.conare.ai/zh/mcp-server.md)


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