HTTP API Reference
APIBASE exposes data through a deterministic HTTP interface using coordinate addressing and scoped security.
Stateless Auth
Requests are validated independently via bearer tokens. No sessions required.
Coordinate Logic
Data is accessed by explicit addresses: Table → Record → Column.
Predictable Output
The same coordinate request always yields the same result structure.
1. Authentication & API Modes
All requests require a bearer token in the header: Authorization: Bearer YOUR_TOKEN.
Personal API (/api/)
Full Read/Write access to your own BASE. The token automatically identifies your storage.
HIVE Gateway (/hive/)
Collaboration access to shared department BASEs using a basekey and ACL validation.
2. Addressing Model
APIBASE translates logical requests into physical TLC coordinates internally.
- T (Table): Numeric ID of the table (e.g.,
T2). - L (Line/Record): Targets a record by its Primary Identifier (e.g.,
L95). - C (Column): Numeric ID of the column (e.g.,
C2).
L targets the logical identity.
Note that using L alone without an ID (e.g., /T2/L/C5...) instructs the engine to scan the entire table rather than a single record.
3. Filtering with Operators
To perform searches across a table, extend the TLC path with O (Operator) and V (Value). As noted above, use a naked L to search all records.
/api/get/T[id]/L/C[id]/O[op]?V=[value]
| OP | Symbol | Meaning | Example (Global Search) |
|---|---|---|---|
| 1 | == | Equal | .../L/C2/O1?V=100 |
| 3 | != | Not equal | .../L/C2/O3?V=100 |
| 6 | < | Less than | .../L/C5/O6?V=50 |
| 7 | > | Greater than | .../L/C5/O7?V=50 |
| 28 | LIKE | Partial match | .../L/C2/O28?V=Dune |
| 32 | BETWEEN | Range (use _) | .../L/C5/O32?V=10_20 |
| 33 | LIST | In List (use _) | .../L/C1/O33?V=1_2_3 |
4. Output Formats
Control the response structure using the format parameter.
- default: Standard indexed JSON.
- assoc: Returns named fields (associative array).
- meta: Returns headers, row counts, and coordinates before the data.
- raw: Returns the plain text value of a single cell.
5. Write Operations (Personal API)
Create (POST)
Adds a new record to the table.
POST /api/post/T2
{ "record": { "title": "Dune" } }
Update Cell (PUT)
Updates a specific coordinate (TLC).
PUT /api/put/T2/L1/C2
{ "value": "New Title" }