[ PROMPT_NODE_23602 ]
guidelines
[ SKILL_DOCUMENTATION ]
## 概述
本文档为智能体与 Neon API 交互提供了一套全面的规则和指南。Neon API 是一项 RESTful 服务,允许对所有 Neon 资源进行编程管理。遵守这些规则可确保正确、高效且安全地使用 API。
### 通用 API 指南
所有 Neon API 请求必须发送至以下基础 URL:
https://console.neon.tech/api/v2/
要构建完整的请求 URL,请将特定的端点路径附加到此基础 URL 之后。
### 认证
- 所有 API 请求必须使用 Neon API 密钥进行认证。
- API 密钥必须包含在 `Authorization` 请求头中,使用 `Bearer` 认证方案。
- 请求头格式应为:`Authorization: Bearer $NEON_API_KEY`,其中 `$NEON_API_KEY` 是有效的 Neon API 密钥。
- 没有有效 `Authorization` 请求头的请求将失败,并返回 `401 Unauthorized` 状态码。
### API 速率限制
- Neon 将 API 请求限制为每分钟 700 次(约每秒 11 次)。
- 每个路由每秒允许最多 40 次的突发请求。
- 如果超过速率限制,API 将返回 `HTTP 429 Too Many Requests` 错误。
- 您的应用程序逻辑必须处理 `429` 错误,并实施带有适当退避策略的重试机制。
### Neon 核心概念
要有效使用 Neon Python SDK,必须了解其核心资源的层次结构和用途。下表提供了每个概念的高级概述。
| 概念 | 描述 | 类比/用途 | 关键关系 |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| 组织 | 最高级别的容器,管理计费、用户和多个项目。 | GitHub 组织或公司的云账户。 |