快速入门

📚 技术术语的定义，以便更好地理解 customGPT。

👍TL;DR：不喜欢阅读文档？直接跳到我们在 github 上的食谱。

本快速入门指南旨在促进 customGPT 的入门过程，包括生成帐户、获取 API 密钥和进行首次 API 调用的步骤。

第 1 步：生成帐户

要使用 customGPT 网站，您需要注册一个帐户。

1. 单击此处打开 customGPT 网站进行注册
2. 单击 “创建帐户” 按钮。

1. 输入您的姓名、电子邮件地址和密码以创建您的帐户。

🙊嘘密码剑

务必将您的密码保密，不要与任何人分享。

1. 单击 “注册” 按钮。

现在您已准备好创建您的第一个项目 ✅

第2步：获取API密钥

1. 单击项目仪表板右上角的圆圈时，从出现的下拉菜单中选择 “我的个人资料”选项。

1. 选择 “API” 选项。

1. 单击 “更改 API 密钥” 按钮生成新的 API 密钥。

1. 选择“更改 API 密钥” 按钮。

1. API密钥已成功生成。您可以使用它来进行 API 调用。

🚧警告

请确保您的 API 密钥安全且保密，以防止未经授权的访问和潜在的安全漏洞。

第 3 步：进行第一个 API 调用

API 的身份验证通过 HTTP 基本身份验证执行。要使用 CustomGPT API 端点进行身份验证，您必须在标头中提供 API 密钥，如下所示。

认证头

'authorization: Bearer Your_API_KEY' 

例如，您将使用端点创建一个新项目。在这种情况下，您可以通过在身份验证标头中添加 API 密钥来发送 API 请求，如下所示：POST - Create new project

搜索列表示例

curl --request POST \
     --url http://127.0.0.1:8000/api/v1/projects \
     --header 'accept: application/json' \
     --header 'authorization: Bearer Your_API_KEY' \
     --header 'content-type: application/json' \
     --data '
{
  "project_name": "projectname",
  "sitemap_path": "https://example.com/sitemap.xml"
}
'