注册和使用 API 密钥

在本教程中,您将学习如何在 Rememberizer 中创建一个公共知识并获取其 API 密钥,以通过 API 调用连接和检索其文档。

前提条件

首先,您需要使用您的索引知识文件创建并完善一个备忘录

创建共享知识

要创建共享知识,请登录您的 Rememberizer 账户并访问 您的共享知识页面。选择 “您的共享知识”,然后点击 “开始”

共享知识页面

然后选择您之前创建的其中一个纪念品,您也可以选择 “全部”“无”

创建共享知识 1

最后填写共享知识的名称、描述,并提供一张代表性的照片。

创建共享知识 2

填写完表单后,点击底部的“分享知识”以创建您的共享知识。之后,打开您的知识中的 “启用分享” 并在弹出窗口中点击 “确认”

共享知识分享

您现在可以获取其 API 密钥并通过 API 调用访问其文档。

获取您创建的公共知识的 API 密钥

对于您的公共知识,请点击右上角的三个点,然后选择“API 密钥”。如果还没有,将为您创建一个。如果 API 密钥存在,将返回该密钥。

knowledge open API key

“管理您的 API 密钥” 面板中,您可以点击 “眼睛” 按钮以显示/隐藏,点击 “复制” 按钮将密钥复制到剪贴板,以及点击 “重新生成 API 密钥” 以使旧密钥失效并创建一个新密钥(通过 API 调用访问您文档的应用程序在您更新新密钥之前将无法访问)。

copy api key

获得 API 密钥后,您可以在对 Rememberizer 的 API 调用中使用它,以查询您索引的文档和内容。

使用 API 密钥

要访问 Rememberizer 端点,您需要在 API 请求的 X-API-Key 头中使用 API 密钥。请查看 API 文档 以了解 Rememberizer 提供的端点。

一旦您拥有 API 密钥,可以通过几种方式使用它:

  1. 直接 API 访问:在您的 HTTP 请求中使用 API 密钥查询 Rememberizer 的搜索端点

  2. LangChain 集成:使用 LangChain 集成 将 Rememberizer 的功能融入您的 LangChain 应用程序

  3. 自定义 GPT:在自定义 GPT 应用程序中使用 API 密钥,如下所述

使用自定义 GPT

首先在 ChatGPT UI 中创建一个 GPT。确保选择身份验证类型为“API 密钥”,身份验证类型为“自定义”,并将头部设置为“X-Api-Key”,然后将您之前复制的密钥粘贴到 API 密钥文本框中。

有关使用 OAuth 而不是 API 密钥的更高级的 GPT 集成,请参见 创建一个 Rememberizer GPT

gpt app using api key

Last updated