Quick Start Guide

circle-info

💡 Create a project on bkend and fetch your first data from your app in just 10 minutes.

Overview

This guide walks you through the entire process from signing up to making your first REST API call.


Full Process

spinner

Prerequisites

  • A web browser

  • An AI tool installed (Claude Code, Cursor, etc.) — optional if you only plan to use the REST API without MCP


Step 1: Sign Up

  1. Log in with your Google or GitHub account. Magic link login is also supported.

circle-check
bkend console login screen

Step 2: Create an Organization

  1. Click the Create Organization button in the console.

  2. Enter an organization name (e.g., My Startup).

  3. Click Create.


Step 3: Create a Project

  1. Click the Projects menu on the organization page.

  2. Click the Create Project button.

  3. Fill in the following information.

Field
Example
Description

Project Name

My Blog

Display name for the project

Project Slug

my-blog

URL identifier (can be auto-generated)

Region

Seoul (ap-northeast-2)

Data storage region

Cloud

AWS

Cloud provider

  1. Click Create.

circle-exclamation

Step 4: Connect an AI Tool

Add the following to your ~/.claude.json file.

Restart Claude Code and the OAuth 2.1 authentication flow will start automatically.


Step 5: Create Your First Table

Ask the AI tool something like this:

Verify the created table in the Database menu of the console.

Database table list showing the created posts table
circle-info

💡 The table has been created, but you need an API Key to insert data from your app. Continue to steps 6 and 7.


Step 6: Create an API Key

You need an API Key to call the REST API from your app.

  1. Click API Keys in the sidebar.

  2. Under Publishable Keys, click the Add Key button.

  3. Enter a name (e.g., my-app-key) and click Create.

  4. The key will be displayed. Copy it and store it securely.

circle-exclamation
triangle-exclamation

Step 7: Create Your First Data

Use the issued Publishable Key to create data from your app.

circle-info

💡 All bkend data APIs follow the /v1/data/{tableName} pattern. The posts table you created above is accessible at /v1/data/posts.

Response Example

Verify the created data in the console under Database > posts table.

circle-check

Bonus: Add Authentication

Now that you can create data, add user authentication to track who created each record.

Step 8: Call the Signup API

Step 9: Create Authenticated Data

When you create data with the issued accessToken, the createdBy field is automatically populated with the user ID.

circle-info

💡 With authentication in place, you can apply RLS (Row Level Security) policies such as "only the creator can edit or delete their own data." See Writing RLS Policies.


Troubleshooting

Error Code
Cause
Solution

401 Unauthorized

API Key is missing or incorrect

Check the Authorization header

404 Not Found

Table does not exist

Verify table creation in the console

400 Bad Request

Required field missing or type mismatch

Check the request body

403 Forbidden

Environment is not Active

Check environment status in the console


Next Steps

Last updated