Sign out of the application

Nile Documentation

Nile - PostgreSQL re-engineered for B2B apps

Introduction

What is Nile

Run Locally

Getting started with Nile's Postgres platform locally with Docker

Architecture

Architecture of Nile Postgres

Testing

Integration testing with Nile's Postgres platform using Docker

Tenant Virtualization

Tenant Isolation

Tenant Management

Tenant Placement

Tenant Sharing

Introduction to Postgres

Create Table

Creating a table in Postgres

Indexes

Indexes in Postgres

Joins

Joins in Postgres

Views

Views in Postgres

Compatibility

Postgres Compatibility

Pgvector

Spatial and Geographic Objects for PostgreSQL

PostGIS

UUID-OSSP

Crypto

Comparison

Get Started

Learn how to self-host Nile Auth in your own infrastructure

Self Host Nile Auth

End to end examples for adding Nile Auth to your B2B application

Examples

Magic Link

Future plans and upcoming features for Nile Auth

Roadmap

Generative AI

Generative AI & Embeddings

Vector Database

PG-Vector

Getting started with pgvector

Retrieval Augmented Generation (RAG)

Streaming

Streaming model responses to the client in real-time

RAG vs Finetune

When to use RAG and when to fine-tune a model

Model Context Protocol

Command line interface for managing Nile databases

Connecting to Nile

Interacting with Database

Managing Workspaces

Managing Tenants

Using Authentication

Setting Configurations

Local Development

Command line flags that can be used with any Nile CLI command

Global Flags

AWS Bedrock

Cohere

Confluent Cloud

LlamaIndex

Modal

Netlify

Vercel

AWS Lambda

Serverless Multi-tenant Backend with AWS Lambda

NextAuth

NextAuth Authentication with Nile

Stripe

Build SaaS with paid subscriptions - using Nile and Stripe

Deploy globally accelerated B2B applications with Cloudflare Workers and Hyperdrive

Cloudflare

BetterAuth

Pipedream

Support

Backup and Restore

Lists all credentials that exist for a database. The id of the credential is
included in the response, but not the password. Passwords are provided only once,
at the time the credential is created, and are encrypted for storage.


Lists credentials for a database

Generates a new secure credential for a database. The generated password is
returned in the response, and is the only time the password is available in
plaintext. No request body is required."


Create a database credential

Lists all of the databases in a workspace.


List databases

Creates a database record in the control plane and triggers creation in the
target region. Database names must be less than 64 characters, and unique
within a workspace. Names may contain letters (lower or uppercase), numbers,
and underscores, and must begin with a letter or underscore.


Create a database

Get a database

Marks a database as deleted and queues its data for deletion. The database will
no longer appear in your Nile dashboard. You will be able to connect to it and
operate on it while it is queued for deletion, but compute costs still apply.


Delete a database

Retrieve the list of available region identifiers for a workspace.
Identifiers are composed of a prefix indicating the underlying cloud provider
followed by a region name in that provider. For example `AWS_US_WEST_2` is
associated with the `us-west-2` region (Portland, OR) of AWS.


List available regions

Lists all developer invites in a workspace

List developer invites

Sends an email to another developer with a link that allows them to join the
workspace.


Invite a developer to a workspace

Deletes a previously issued invite

Returns information about the developer associated with the token provided,
including the workspaces and database ids the developer is authorized to access,
and the email address associated with the developer.


Identify developer details

Lists all workspaces that an authenticated developer is authorized to use.


List workspaces

Creates a workspace for the authenticated developer. A workspace slug is
generated from the workspace name and used as the workspace identifier.
Workspace slugs must be globally unique.
Generated slugs will only include ASCII characters. Spaces and non-ASCII
characters are replaced with hyphens.


Create a workspace

Get workspaces

List details about the developers authorized to access the workspace.


List developers with access to a workspace

Post oauth2token

Authenticates a user and creates a session.

Sign in to the application

Returns the session object if the user is authenticated.

Get the current session

Returns a CSRF token to be used in subsequent requests.

Get CSRF token

Returns a list of available authentication providers.

Get available providers

Handles the callback from an authentication provider.

Handle provider callback

Refreshes the session token to extend the session duration.

Refresh session token

Responds to a link (probably in an email) by setting a cookie that allows for a password to be reset

Retrieve password token

Based on a cookie, allows a user to reset their password

Resets the password

Sends an email for a user to reset their password

Reset password

Returns information about the principal associated with the session provided

Identify the principal

Update the principal in the associated with the session provided

update the principal profile

Creates a user in the database and then logs them in.

Signs up a new user

A user that already exists is added to a tenant

links an existing user to a tenant

Marks a user to be deleted from the tenant. It does not remove the user from other tenants or invalidate active sessions.

Unlinks a user from a tenant

Updates a user, provided the authorized user is in the same tenant as that user

update a user

Returns a list of tenant users from the database

a list of tenant users

create a new user and assigns them to a tenant

lists tenants of user

Creates a user

get a tenant

update a tenant

delete a tenant

makes a tenant, assigns user to that tenant

creates a tenant

Explore Nile in 5 minutes with PSQL

NextJS

Build a B2B Application with Postgres and NextJS

Drizzle

Build AI-Native B2B application with Postgres and Drizzle ORM

Prisma

Build AI-Native B2B application with Postgres and Prisma

Python

Build AI-Native B2B application with Postgres and Python

Node

Build AI-Native B2B application with Postgres, NodeJS and React

SmartBooks AI

SmartBooks AI - Your Intelligent Accounting Partner

SmartSpend AI

SmartSpend AI - Set teams free from manual expenses

Feedback360 AI

Feedback360 AI - 360-Degree Feedback, Perfected with AI

HealthPilot

HealthPilot - Enhancing Patient Care with Intelligent Assistance

RecruitAI

RecruitAI - Smarter Hiring, Powered by AI

HRIntelli

HRIntelli - Magically Simplifying HR with AI

TaskPilot AI

TaskPilot AI - Your AI-Driven Guide to Seamless Task Management

SalesLeadPilot

SalesLeadPilot - AI-Driven Guidance for Superior Lead Management

LawPilot

LawPilot AI - AI That Thinks Like a Lawyer

SmartCampaign AI

SmartCampaign AI - Your AI-Driven Marketing Ally

SmartNotion AI

SmartNotion AI - Crafting Organized Thoughts with Artificial Intelligence

OnboardIQ

OnboardIQ - Transform Customer Onboarding with Insightful AI

CalendIQ

CalendIQ - Intelligent Calendar Management for Busy Lives

SmartLearn

SmartLearn: AI Intelligence for the Modern Classroom

Slack++

Slack++ - Built with AI to power work

SupplyAI

SupplyAI - AI-Powered Efficiency for Your Supply Chain

CustomerDesk AI

CustomerDesk AI - AI-Powered Efficiency for Your Supply Chain

AITravelMate

AITravelMate - your business trips managed by AI

KnowledgeAI

KnowledgeAI - PDF search assistant for your organization

Code Assistant

Autonomous Code Assistant - Code more, type less

Sales Insight

Sales Insight - AI-native, multi-tenant enterprise sales assistant

auth

users

tenants

Sign out of the application

Path Parameters

Response