Start

Getting started

Understand the Pikbase model and make your first contract-backed query.

Contract sourcePikbase docs

Pikbase is a backend platform built around entities, definitions, and permission-scoped operations. The same contracts power the console, SDK, CLI, and MCP tools.

Choose your surface

Surface	Best for
Console	Exploring definitions, data, functions, and workflows
Entity Service	Application data access through the TypeScript client
`gsb` CLI	Development, inspection, and repeatable operations
MCP server	Permission-scoped tools for AI-enabled editors and agents

Before you begin

You need a Pikbase tenant and an account with access to that tenant. Keep credentials server-side. Browser applications use the established authentication flow and the direct Entity Service client; never bundle an API key or client secret.

First steps

Sign in to the console and inspect an entity definition.
Use the query builder to verify the data shape and access policy.
Initialize the CLI with your tenant.
Inspect the read-only tool catalog before running an operation.

gsb init --tenant your-tenant
gsb tools --read-only
gsb call getDocs --input '{"methodName":"query"}' --raw

Continue with core concepts, then use the query reference for the exact request and response contract.