> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/neon.md).

# Neon

Manage Neon PostgreSQL projects, branches, databases, and SQL queries.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector               | Authentication   |
| ----------------------- | ---------------- |
| Neon (Personal API Key) | Personal API Key |

#### Neon (Personal API Key)

Connect Neon to manage projects, branches, databases, and run SQL.

**Set up in Neon**

1. Prepare the Neon account or service that the workflow will access. Grant access to the required resources and operations.
2. **Personal API Key:** Create a personal API key in Neon Console under Account settings > API keys.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Neon (Personal API Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field    | Required | What to enter                                                                                                                                          |
| ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Personal API Key | Yes      | Create a personal API key in Neon Console under Account settings > API keys. [Provider instructions](https://console.neon.tech/app/settings/api-keys). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Neon** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Projects

Find Neon projects with bounded cursor pagination.

**Inputs**

| Field            | Type    | Required | Description                                                |
| ---------------- | ------- | -------- | ---------------------------------------------------------- |
| Search           | string  | No       | Partial project name or ID.                                |
| Organization ID  | string  | No       | Limit results to one Neon organization.                    |
| Cursor           | string  | No       | Continue a previous project listing.                       |
| Maximum Projects | integer | No       | Maximum projects to return. Default: 10.                   |
| Recoverable Only | boolean | No       | Only include recoverable deleted projects. Default: false. |

**Outputs**

| Field                   | Type    | Description                                      |
| ----------------------- | ------- | ------------------------------------------------ |
| Projects                | array   | Matching Neon projects.                          |
| Next Cursor             | string  | Cursor for more projects.                        |
| Unavailable Project IDs | array   | Projects Neon could not load before its timeout. |
| Partial Result          | boolean | Whether some matching projects were unavailable. |

#### Create Project

Create a live Neon PostgreSQL project.

**Inputs**

| Field                    | Type            | Required | Description                                                                                                            |
| ------------------------ | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| Project Name             | string          | Yes      | Name for the new Neon project.                                                                                         |
| Organization             | select (string) | No       | Organization that will own the project. Omit for a personal project. Options load from the selected connection.        |
| Region                   | select (string) | No       | Neon region for the project. Options load from the selected connection.                                                |
| PostgreSQL Version       | select (string) | No       | PostgreSQL major version. Available values: PostgreSQL 14, PostgreSQL 15, PostgreSQL 16, PostgreSQL 17, PostgreSQL 18. |
| Store Role Passwords     | boolean         | No       | Allow this integration to retrieve connection URIs for Run SQL Query. Default: true.                                   |
| Confirm Project Creation | boolean         | No       | Confirm creation of a live quota-bearing project. Default: false.                                                      |

**Outputs**

| Field              | Type   | Description                               |
| ------------------ | ------ | ----------------------------------------- |
| Project            | object | Created Neon project without credentials. |
| Initial Branch ID  | string | Initial branch created with the project.  |
| Operation Statuses | array  | Asynchronous creation operation states.   |

#### Create Branch

Create a Neon branch with optional read-write compute.

**Inputs**

| Field                     | Type            | Required | Description                                                                                       |
| ------------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------- |
| Project                   | select (string) | Yes      | Project that will own the branch. Options load from the selected connection.                      |
| Branch Name               | string          | Yes      | Name for the new branch.                                                                          |
| Parent Branch             | select (string) | No       | Branch to copy. Omit for the project's default branch. Options load from the selected connection. |
| Create Read-Write Compute | boolean         | No       | Create a compute endpoint so the branch can run SQL. Default: true.                               |
| Confirm Branch Creation   | boolean         | No       | Confirm creation of a quota-bearing branch and optional compute. Default: false.                  |

**Outputs**

| Field                | Type   | Description                               |
| -------------------- | ------ | ----------------------------------------- |
| Branch               | object | Created Neon branch.                      |
| Compute Endpoint IDs | array  | Compute endpoints created for the branch. |
| Operation Statuses   | array  | Asynchronous creation states.             |

#### Create Database

Create a PostgreSQL database on a Neon branch.

**Inputs**

| Field                     | Type            | Required | Description                                                                          |
| ------------------------- | --------------- | -------- | ------------------------------------------------------------------------------------ |
| Project                   | select (string) | Yes      | Project containing the branch. Options load from the selected connection.            |
| Branch                    | select (string) | Yes      | Branch that will contain the database. Options load from the selected connection.    |
| Database Name             | string          | Yes      | PostgreSQL database name.                                                            |
| Owner Role                | select (string) | Yes      | Existing role that will own the database. Options load from the selected connection. |
| Confirm Database Creation | boolean         | No       | Confirm this live schema and storage mutation. Default: false.                       |

**Outputs**

| Field              | Type   | Description                   |
| ------------------ | ------ | ----------------------------- |
| Database           | object | Created Neon database.        |
| Operation Statuses | array  | Asynchronous creation states. |

#### Run SQL Query

Run one parameterized SQL query against a Neon database.

**Inputs**

| Field                     | Type            | Required | Description                                                                             |
| ------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| Project                   | select (string) | Yes      | Project containing the database. Options load from the selected connection.             |
| Branch                    | select (string) | Yes      | Branch whose compute will execute the query. Options load from the selected connection. |
| Database                  | select (string) | Yes      | Database to query. Options load from the selected connection.                           |
| Role                      | select (string) | Yes      | Database role used for the query. Options load from the selected connection.            |
| SQL Query                 | textarea        | Yes      | One parameterized PostgreSQL statement.                                                 |
| Parameters                | array           | No       | Values bound to $1, $2, and later placeholders. Default: \[].                           |
| Read Only                 | boolean         | No       | Ask Neon to enforce a read-only transaction. Default: true.                             |
| Confirm Write-Capable SQL | boolean         | No       | Confirm that this SQL may change or delete database data.                               |

**Outputs**

| Field        | Type   | Description                               |
| ------------ | ------ | ----------------------------------------- |
| Query Result | object | Bounded SQL result with columns and rows. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/neon.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
