Nhost API Reference

API reference for Nhost backend services (auth, storage, AI), client libraries, project configuration, the CLI and Kriti templating, with an interactive API Playground.

This reference section is home to the backend services, the client libraries, the project configuration, the CLI, and the templating language.

Configuration

Every setting available in nhost.toml, the file that defines a project’s services, resources, and providers.

Configuration

Full reference for the project configuration file

Backend Services

The API reference for the authentication, storage, and AI services. Auth and Storage come with an API Playground to help you learn and test the endpoints against a local Nhost instance.

To learn how to start a local Nhost instance check out local development. Starting a local instance is optional and only required if you want to use the playground to simulate real requests.

Auth API

REST endpoints for sign-in, sign-up, sessions, and user management

Storage API

REST endpoints for uploading, downloading, and transforming files

AI GraphQL

Queries and mutations for assistants and sessions

Client Libraries

The APIs for all available client libraries.

@nhost/nhost-js

JavaScript SDK wrapping auth, storage, GraphQL, and functions in a single client

CLI

The command line interface for local development, deployments, and project management.

Commands

Every nhost command, with its flags and arguments

Templating

Kriti

The JSON templating language used to reshape payloads in features such as request and payload transformations