File contents Neon Platform API
The Neon Platform API allows you to manage Neon projects, branches, databases, and resources programmatically. You can use the REST API directly or through official SDKs.
Options
Method
Package/URL
Best For
REST API
https://console.neon.tech/api/v2/Any language, direct HTTP calls
TypeScript SDK
@neondatabase/api-clientNode.js, TypeScript projects
Python SDK
neon-apiPython scripts and applications
CLI
neonctlTerminal-based management
Documentation
# REST API documentation
curl -H "Accept: text/markdown" https://neon.com/docs/reference/api-reference
# TypeScript SDK
curl -H "Accept: text/markdown" https://neon.com/docs/reference/typescript-sdk
# Python SDK
curl -H "Accept: text/markdown" https://neon.com/docs/reference/python-sdk
# CLI
curl -H "Accept: text/markdown" https://neon.com/docs/reference/neon-cli
For the interactive API reference: https://api-docs.neon.tech/reference/getting-started-with-neon-api
Sub-Resources
For detailed information, reference the appropriate sub-resource:
REST API Details
Topic
Resource
Guidelines, Auth, Rate Limits
neon-rest-api/guidelines.md
Projects
neon-rest-api/projects.md
Branches, Databases, Roles
neon-rest-api/branches.md
Compute Endpoints
neon-rest-api/endpoints.md
API Keys
neon-rest-api/keys.md
Operations
neon-rest-api/operations.md
Organizations
neon-rest-api/organizations.md
SDKs
Language
Resource
TypeScript
neon-typescript-sdk.md
Python
neon-python-sdk.md
Quick Start
Authentication
All API requests require a Neon API key:
Authorization: Bearer $NEON_API_KEY
API Key Types
Type
Scope
Best For
Personal
All projects user has access to
Individual use, scripting
Organization
Entire organization
CI/CD, org-wide automation
Project-scoped
Single project only
Project-specific integrations
Rate Limits
700 requests per minute (~11 per second)
Bursts up to 40 requests per second per route
Handle 429 Too Many Requests with retry/backoff
Common Operations Quick Reference
Operation
REST API
TypeScript SDK
Python SDK
List Projects
GET /projectslistProjects({})projects()
Create Project
POST /projectscreateProject({...})project_create(...)
Get Connection URI
GET /projects/{id}/connection_urigetConnectionUri({...})connection_uri(...)
Create Branch
POST /projects/{id}/branchescreateProjectBranch(...)branch_create(...)
Start Endpoint
POST /projects/{id}/endpoints/{id}/startstartProjectEndpoint(...)endpoint_start(...)
Error Handling
Status
Meaning
Action
401
Unauthorized
Check API key
404
Not Found
Verify resource ID
429
Rate Limited
Implement retry with backoff
500
Server Error
Retry or contact support
1 --- 2 name: 2867-neon-platform-api-e46586ec 3 description: Neon Platform API 4 --- 5 # Neon Platform API 6 7 The Neon Platform API allows you to manage Neon projects, branches, databases, and resources programmatically. You can use the REST API directly or through official SDKs. 8 9 ## Options 10 11 | Method | Package/URL | Best For | 12 | -------------- | ----------------------------------- | ------------------------------- | 13 | REST API | `https://console.neon.tech/api/v2/` | Any language, direct HTTP calls | 14 | TypeScript SDK | `@neondatabase/api-client` | Node.js, TypeScript projects | 15 | Python SDK | `neon-api` | Python scripts and applications | 16 | CLI | `neonctl` | Terminal-based management | 17 18 ## Documentation 19 20 ```bash 21 # REST API documentation 22 curl -H "Accept: text/markdown" https://neon.com/docs/reference/api-reference 23 24 # TypeScript SDK 25 curl -H "Accept: text/markdown" https://neon.com/docs/reference/typescript-sdk 26 27 # Python SDK 28 curl -H "Accept: text/markdown" https://neon.com/docs/reference/python-sdk 29 30 # CLI 31 curl -H "Accept: text/markdown" https://neon.com/docs/reference/neon-cli 32 ``` 33 34 For the interactive API reference: https://api-docs.neon.tech/reference/getting-started-with-neon-api 35 36 ## Sub-Resources 37 38 For detailed information, reference the appropriate sub-resource: 39 40 ### REST API Details 41 42 | Topic | Resource | 43 | ----------------------------- | -------------------------------- | 44 | Guidelines, Auth, Rate Limits | `neon-rest-api/guidelines.md` | 45 | Projects | `neon-rest-api/projects.md` | 46 | Branches, Databases, Roles | `neon-rest-api/branches.md` | 47 | Compute Endpoints | `neon-rest-api/endpoints.md` | 48 | API Keys | `neon-rest-api/keys.md` | 49 | Operations | `neon-rest-api/operations.md` | 50 | Organizations | `neon-rest-api/organizations.md` | 51 52 ### SDKs 53 54 | Language | Resource | 55 | ---------- | ------------------------ | 56 | TypeScript | `neon-typescript-sdk.md` | 57 | Python | `neon-python-sdk.md` | 58 59 ## Quick Start 60 61 ### Authentication 62 63 All API requests require a Neon API key: 64 65 ```bash 66 Authorization: Bearer $NEON_API_KEY 67 ``` 68 69 ### API Key Types 70 71 | Type | Scope | Best For | 72 | -------------- | ------------------------------- | ----------------------------- | 73 | Personal | All projects user has access to | Individual use, scripting | 74 | Organization | Entire organization | CI/CD, org-wide automation | 75 | Project-scoped | Single project only | Project-specific integrations | 76 77 ### Rate Limits 78 79 - 700 requests per minute (~11 per second) 80 - Bursts up to 40 requests per second per route 81 - Handle `429 Too Many Requests` with retry/backoff 82 83 ## Common Operations Quick Reference 84 85 | Operation | REST API | TypeScript SDK | Python SDK | 86 | ------------------ | ------------------------------------------ | --------------------------- | --------------------- | 87 | List Projects | `GET /projects` | `listProjects({})` | `projects()` | 88 | Create Project | `POST /projects` | `createProject({...})` | `project_create(...)` | 89 | Get Connection URI | `GET /projects/{id}/connection_uri` | `getConnectionUri({...})` | `connection_uri(...)` | 90 | Create Branch | `POST /projects/{id}/branches` | `createProjectBranch(...)` | `branch_create(...)` | 91 | Start Endpoint | `POST /projects/{id}/endpoints/{id}/start` | `startProjectEndpoint(...)` | `endpoint_start(...)` | 92 93 ## Error Handling 94 95 | Status | Meaning | Action | 96 | ------ | ------------ | ---------------------------- | 97 | 401 | Unauthorized | Check API key | 98 | 404 | Not Found | Verify resource ID | 99 | 429 | Rate Limited | Implement retry with backoff | 100 | 500 | Server Error | Retry or contact support |
commit bce5e8313c
Frequently asked questions How do I install the 2867 Neon Platform API E46586ec skill? Run npx skillmds@latest add tools-only/2867-neon-platform-api-e46586ec in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
What does the 2867 Neon Platform API E46586ec skill do? Neon Platform API It is listed under Integrations & APIs on SkillMD.
Is 2867 Neon Platform API E46586ec safe to use? This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
Which AI agents work with 2867 Neon Platform API E46586ec? This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Is 2867 Neon Platform API E46586ec free to use? Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
Who published 2867 Neon Platform API E46586ec? tools-only (@tools-only) published this skill. Their other Agent Skills are listed on their SkillMD profile.
tools-only