Neon API

Name: Neon API API
Brand: Neon API
Availability: InStock

✓ Official Vendor SpecStorageDatabasebearer138 EndpointsREST

For Agents

Manage Neon Postgres projects, branches, compute endpoints, roles, and API keys, and inspect long-running operations and advisor findings.

Quickstart

Get started with Neon API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create a neon postgres branch"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Neon API API.

Provision and destroy Neon projects with regions and Postgres versions chosen at create time

Create branches off any project for preview environments, restore from a point in time, or fork production data

Spin up compute endpoints (read-write and read replicas) attached to a branch

Create roles and databases inside a branch, and rotate or fetch role passwords

GET STARTED

Start building with Neon API API

Explore with Jentic

View OpenAPI Document

Use for: Create a new Neon project in a specific region, Create a branch off the production database for a preview environment, Spin up a read-replica compute endpoint on an existing branch, List every project the current API key can see

Not supported: Does not handle direct SQL execution, in-database row reads, or schema migrations — use for Neon platform management of projects, branches, and compute endpoints only.

Use Cases

Patterns agents use Neon API API for, with concrete tasks.

★ Per Pull Request Database Branches

Engineering teams script /projects/{project_id}/branches so every pull request gets its own isolated Postgres branch off the production schema and data. The branch is a copy-on-write fork — provisioning takes seconds, the preview environment runs migrations against real data, and the branch is deleted when the PR closes. This replaces the slow restore-from-dump pattern most CI pipelines previously used.

Create a branch named pr-1234 off the main branch of project shadowy-snow-12345, then return the connection string for the new compute endpoint.

Read Replica Provisioning

Backend services need read scaling for analytics and dashboards without slowing the write path. Neon supports adding read-replica compute endpoints to a branch, so an agent can attach a replica through the endpoints API and route a BI workload there while the primary endpoint serves transactional traffic. Replicas spin up in seconds and scale to zero when idle.

Create a read-replica compute endpoint on the main branch of a Neon project and return its connection string for the BI dashboard.

Service Account Key Management

Platform teams use /api_keys to mint scoped tokens for CI, agents, and ops scripts, and to revoke them when a service is decommissioned. Combined with /projects scoping, the result is least-privilege access where each automation has its own key and the audit trail shows which key took which action.

Mint a new Neon API key named ci-runner-prod and return the token, then list existing keys to confirm it appears.

Restore from Point in Time

Operations engineers respond to bad migrations by calling /projects/{project_id}/restore against a recent timestamp. Neon resolves the request to a fresh branch with the data state at that timestamp, and /projects/{project_id}/operations/{operation_id} reports progress. The recovery window is bounded by the project history retention setting.

Restore the main branch of a Neon project to its state from 2 hours ago and poll the operation until it reports finished.

AI Agent Integration via Jentic

An AI agent uses Jentic to provision Neon resources during a deploy or test workflow. Jentic exposes /projects, /branches, and /endpoints by intent, and the agent supplies the project, region, and Postgres version. The Neon bearer key never enters the agent context — it stays in the Jentic vault.

Use Jentic to search for create a neon project, load the schema, and create a project named agent-demo in the us-east-2 region.

Key Endpoints

138 endpoints — the neon api is the management plane for neon, the serverless postgres platform with database branching.

METHOD

PATH

DESCRIPTION

GET

/projects

List Neon projects

POST

/projects

Create a new Neon project

GET

/projects/{project_id}

Get a project by id

POST

/projects/{project_id}/restore

Restore a branch to a point in time

GET

/projects/{project_id}/operations/{operation_id}

Get operation status

GET

/api_keys

List API keys

POST

/api_keys

Mint an API key

DELETE

/api_keys/{key_id}

Revoke an API key

GET

/projects

List Neon projects

POST

/projects

Create a new Neon project

GET

/projects/{project_id}

Get a project by id

POST

/projects/{project_id}/restore

Restore a branch to a point in time

GET

/projects/{project_id}/operations/{operation_id}

Get operation status

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Neon bearer keys are stored encrypted in the Jentic MAXsystem vault. Agents receive scoped access at execution time and the raw key never enters the agent context.

Intent-based discovery

Agents search Jentic by intent (for example, create a neon branch) and Jentic returns the matching operation with its input schema, so the agent calls the right endpoint without reading 138-page docs.

Time to first call

Direct Neon integration: 1-2 days for auth, branch and endpoint orchestration, and operation polling. Through Jentic: under 1 hour to search, load, and execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Supabase API

Postgres-based backend platform with auth, storage, and edge functions on top of the database

Choose Supabase when the agent needs auth and storage bundled with Postgres rather than a database-only platform.

Alternative

PlanetScale API

Serverless MySQL platform with database branching

Choose PlanetScale when the agent or app is built on MySQL rather than Postgres.

Alternative

Cockroach Cloud API

Distributed SQL database compatible with Postgres wire protocol

Choose Cockroach when the workload needs multi-region active-active rather than serverless scale-to-zero.

Complementary

Vercel API

Frontend cloud that triggers preview deploys, often paired with a Neon branch per pull request

Choose Vercel when the agent must wire a per-PR Neon branch into a Vercel preview deployment environment.

FAQs

Specific to using Neon API API through Jentic.

What authentication does the Neon API use?

The Neon API uses bearer tokens (BearerAuth in the spec) for programmatic clients, and supports cookie-based session auth for the console. Mint a key in the Neon console or via /api_keys, store it in the Jentic vault, and pass it as Authorization: Bearer in every request.

Can I create a database branch with the Neon API?

Yes. POST to the branches endpoint under /projects/{project_id} with a parent_id and an optional point-in-time. Neon returns the new branch immediately and a compute endpoint can be attached to it for read-write access.

How do I provision a Neon project through Jentic?

Search Jentic for create a neon project, load the schema for POST /projects, then execute with the project name, region, and Postgres version. The full flow is pip install jentic, search, load, execute.

What are the rate limits for the Neon API?

Neon enforces account-level concurrency and rate limits that vary by plan. The spec does not include numeric per-second caps, so treat heavy automation (mass branch creation, full project lists) as bursty and back off when 429 responses appear. Long-running actions return an operation id you can poll under /projects/{project_id}/operations.

Can I restore a Neon branch to a previous point in time?

Yes. POST /projects/{project_id}/restore with the source branch and a timestamp inside the project history retention window. Neon creates a new branch at that state and returns an operation id for status tracking under /projects/{project_id}/operations/{operation_id}.

Is the Neon API free?

Neon's free plan includes a project with limited storage and compute time and the API is included; programmatic access is not paywalled. Paid plans raise storage, history retention, and compute limits but use the same 138 endpoints.