Checks if a project slug is available for use

Check project slug availability

basic.tech docs

Build powerful local-first apps with Basic, where your users are always in control of their data.

Welcome

the fastest way to build a local-first app from scratch

Get started with create-lofi-app

Using the @basictech/react library with your React project

Get started with the React SDK

Adding authentication to your project with the Basic API

Get started with the Basic API

Use the Basic CLI

Using the admin portal to create a new project.

Use the Basic admin portal

A full step-by-step guide to building a simple to-do app using Basic's create-lofi-app

Build a local-first To-Do app

Basic makes interop of data between apps super easy

Interop with Basic

Basic Auth

Deeper dive into how schemas work in Basic

Schema management

User-owned data stores

Local-first sync

How users will be able to manage permissions to their data

Managing permissions

External resources

Redirect to sign in

Get auth token

Get user info

Check auth endpoint status

Create item

Get all items in a table

Get specific item in a table

Replace an item

Update an item

Delete an item

Creates a new project for the authenticated user and returns an API key for the project

Create a new project

Retrieves detailed information for a specific project

Get project details

Updates the details of a specific project. Only provided fields will be updated.

Update project details

Retrieves all projects owned by the authenticated user

Get all admin projects of developer

Retrieves the schema configuration for a specific project. Can return either the latest version, a specific version, or all versions.

Get project schema

Updates the schema configuration for a specific project. Creates a new version of the schema.

Update project schema

Permanently deletes a project and all its associated data. This action cannot be undone.

Delete a project

Upload an image file for the project (e.g., project icon, logo). The image will be stored in R2 storage.

Upload project image

Creates a new API key for the project with specified permissions

Create new API key

Retrieves all API keys associated with the project

Get all keys for a project

Retrieves details of a specific API key for the project

Get specific API key

Updates the label and/or roles of an existing API key

Update API key

Regenerates an existing API key with a new value while maintaining the same permissions and label

Regenerate API key

Verifies if an API key is valid for the project and returns its associated permissions

Verify API key

Permanently deletes an API key from the project. This action cannot be undone.

Delete API key

Compare two schemas and return the differences

Compare two schemas

Verify update schema

Converts any text into a URL-friendly slug by removing special characters, converting to lowercase, and replacing spaces with hyphens

Convert text to URL-friendly slug

Check utils endpoint status

Begin the OAuth flow. This endpoint is used to redirect the user to the authorization URL, and will return an authorization code.

Authorize

Use the authorization code to get an access token.

token

userInfo

Retrieve items from a specific table within a project.

Get Items

Add a new item to a specific table within a project.

Add Item

Replace a specific item in a table within a project.

Set Item

Delete a specific item from a table within a project.

Del Item

Update a specific item in a table within a project.

Update Item

Retrieve the account information. Requires the auth token for the account holder.

Account

Retrieve the account's apps. Requires the auth token for the account holder.

Get Apps

Retrieve the account's projects. Requires the auth token for the account holder.

Projects

Project Keys

Utilities

Check project slug availability

Query Parameters

Response