Quickstart

Create your BASE. Explore freely. Activate API when ready.

1. Create BASE

Create your workspace.
Free for 3 days through the web interface.

2. Build Data

Create tables and records
from the web interface.

3. Activate API

Add an email when creating your BASE
to activate API access.

4. Use API

Generate a token and
start making requests.

Web interface usage is free. API execution requires activation and available RQT.

1. Create Your BASE

Create your BASE from the web interface:

Create Your BASE

Choose a base name (lowercase)
Set a password
Login to access your workspace

Free mode: you can use your BASE through the web interface for 3 days without providing an email. API execution is not enabled in this mode.

2. Create Tables

Inside your workspace, create your tables using the left panel:

Tables → Create a table
Add fields (columns)
Add records (rows)

You will address tables by their numeric id (example: T2). Table ids are visible in the left panel (example: 2. authors).

3. Activate API Access

API execution is disabled by default.

To activate API access: add your email to your BASE.

Your BASE becomes persistent
API execution is enabled
You receive 10,000 RQT

Without an email, your BASE stays temporary and is deleted after 3 days.

4. Generate an API Token

Go to:

Main → API → Manage tokens

Generate a token and store it safely. It is displayed only once.

Authorization: Bearer YOUR_TOKEN

A token without RQT cannot execute API requests.

5. First curl Calls (Personal API)

Use your user token (full access). Your BASE is selected by the token.

API requests consume RQT. If your token has 0 RQT, requests will not execute.

# 1) Read a table (replace T2 with your table id)
curl https://apibase.work/api/get/T2 \
  -H "Authorization: Bearer YOUR_TOKEN"

# 2) Create a record (same table id)
curl -X POST https://apibase.work/api/post/T2 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "record": { "title": "Dune" } }'

# 3) Read a single cell as raw value (example: line 1, column 2)
curl https://apibase.work/api/get/T2/L1/C2?format=raw \
  -H "Authorization: Bearer YOUR_TOKEN"

HIVE is for collaboration: shared access to another BASE through /hive/get/<basekey>/... using a hive-scope token and explicit ACL authorization.

API Modes

Personal API

Full access to your own BASE. The token selects the BASE automatically.

/api/get/T2
/api/post/T2
/api/put/T2/L3
/api/delete/T2/L3

HIVE Gateway

Collaboration access to a shared BASE. Requires a hive token and matching ACL authorization.

/hive/get/<basekey>/T2
/hive/get/<basekey>/T2/L3
/hive/get/<basekey>/T2/L3/C2