[ PROMPT_NODE_23594 ]
neon-platform-api
[ SKILL_DOCUMENTATION ]
# Neon 平台 API
Neon 平台 API 允许您以编程方式管理 Neon 项目、分支、数据库和资源。您可以直接使用 REST API 或通过官方 SDK 进行调用。
## 选项
| 方法 | 包/URL | 适用场景 |
| -------------- | ----------------------------------- | ------------------------------- |
| REST API | `https://console.neon.tech/api/v2/` | 任何语言,直接 HTTP 调用 |
| TypeScript SDK | `@neondatabase/api-client` | Node.js, TypeScript 项目 |
| Python SDK | `neon-api` | Python 脚本和应用程序 |
| CLI | `neonctl` | 基于终端的管理 |
## 文档
bash
# REST API 文档
curl -H "Accept: text/markdown" https://neon.tech/docs/reference/api-reference
# TypeScript SDK
curl -H "Accept: text/markdown" https://neon.tech/docs/reference/typescript-sdk
# Python SDK
curl -H "Accept: text/markdown" https://neon.tech/docs/reference/python-sdk
# CLI
curl -H "Accept: text/markdown" https://neon.tech/docs/reference/neon-cli
交互式 API 参考:https://api-docs.neon.tech/reference/getting-started-with-neon-api
## 子资源
有关详细信息,请参考相应的子资源:
### REST API 详情
| 主题 | 资源 |
| ----------------------------- | -------------------------------- |
| 指南、认证、速率限制 | `neon-rest-api/guidelines.md` |
| 项目 | `neon-rest-api/projects.md` |
| 分支、数据库、角色 | `neon-rest-api/branches.md` |
| 计算端点 | `neon-rest-api/endpoints.md` |
| API 密钥 | `neon-rest-api/keys.md` |
| 操作 | `neon-rest-api/operations.md` |
| 组织 | `neon-rest-api/organizations.md` |
### SDK
| 语言 | 资源 |
| ---------- | ------------------------ |
| TypeScript | `neon-typescript-sdk.md` |
| Python | `neon-python-sdk.md` |
## 快速入门
### 认证
所有 API 请求都需要一个 Neon API 密钥:
bash
Authorization: Bearer $NEON_API_KEY
### API 密钥类型
| 类型 | 范围 | 适用场景 |
| -------------- | ------------------------------- | ----------------------------- |
| 个人 |