# Pikbase documentation

> Pikbase is a metadata-driven backend platform: define entities once, then operate governed APIs, functions, workflows, auth, and storage from one console.

Guides and API reference generated from the same contract documentation the
Pikbase CLI and MCP server return.

## Guides

- [Getting started](/getting-started): Understand the Pikbase model and make your first contract-backed query.
- [Core concepts](/guides/core-concepts): Entities, definitions, properties, relationships, workflows, and tenant isolation.
- [Backend platform map](/guides/backend-platform): A complete map of the backend contracts, runtime surfaces, and operational safeguards.
- [Authentication and tenancy](/guides/authentication): Exchange credentials for a token, verify it, and resolve tenant context server-side.
- [Work with entity data](/guides/entity-data): Worked read, query, save, batch, and delete examples through Entity Service.
- [Entity Service CRUD reference](/guides/crud): Types, service surface, query techniques, and aggregation for entity CRUD.
- [Build queries with QueryParams](/guides/query-params): Use one fluent query model across the TypeScript client, CLI, MCP, and serverless code.
- [Advanced and extreme queries](/guides/advanced-queries): Express correlated counts, set membership, analytics, field comparisons, and nested logic with the GSB query model.
- [Transactions, triggers, and commit control](/guides/transactions-triggers): Coordinate atomic graph saves and backend automation with rollback, triggers, and explicit commit checkpoints.
- [Build static applications on Pikbase](/guides/static-apps): Publish a frontend as static files while Pikbase operates its data, security, functions, and workflows.
- [Data tables, policies, and search](/guides/data-access): Build definition-driven tables with query-backed access policies and multilingual full-text search.
- [Multilingual documents and email delivery](/guides/document-delivery): Render localized templates as HTML or PDF and deliver them through a tenant-registered email provider.
- [Design entity schemas](/guides/schema-design): Model definitions, properties, references, indexes, and safe evolution.
- [Schema Manager API](/guides/schema-manager): Manage definitions and properties through the schema service contract.
- [getCommonPropertyDefs() — Schema Manager](/guides/schema-manager/getcommonpropertydefs): List the property data types available when adding columns.
- [createEntityDef() — Schema Manager](/guides/schema-manager/createentitydef): Create a new data table and its initial properties.
- [updateEntityDef() — Schema Manager](/guides/schema-manager/updateentitydef): Change the metadata of an existing data table.
- [getEntityDef() — Schema Manager](/guides/schema-manager/getentitydef): Read one data table by id or name.
- [queryEntityDefs() — Schema Manager](/guides/schema-manager/queryentitydefs): Page through the data tables in a tenant.
- [addProperty() — Schema Manager](/guides/schema-manager/addproperty): Add a column to an existing data table.
- [updateProperty() — Schema Manager](/guides/schema-manager/updateproperty): Change an existing column on a data table.
- [removeProperty() — Schema Manager](/guides/schema-manager/removeproperty): Remove a column from a data table.
- [Serverless functions](/guides/serverless-functions): Author and run backend logic using the documented function runtime.
- [Entity versioning](/guides/entity-versioning): Create restorable snapshots, inspect automatic field history, and choose when a full backup is still required.
- [Workflows](/guides/workflows): Model a process, start an instance, advance its tasks, and audit the run.
- [Pikbase CLI](/tools/cli): Every gsb command, with its real flags and output.
- [MCP server](/tools/mcp): Connect AI clients to permission-scoped Pikbase tools and documentation.
- [getDocs() — MCP documentation tool](/tools/getdocs): Purpose : Retrieves comprehensive API documentation for GSB Entity Service. When to use : Need to understand available API operations Building developer…
- [getApiDocs() — MCP documentation tool](/tools/getapidocs): Purpose : Retrieves general information about the API service. When to use : Checking API version Displaying API metadata Verifying compatibility Gettin…

## API reference

### Entity data (Entity Service)
- [getById](/api/getbyid)
- [getCopy](/api/getcopy)
- [query](/api/query)
- [queryMapped](/api/querymapped)
- [save](/api/save)
- [saveMulti](/api/savemulti)
- [delete](/api/delete)
- [deleteQuery](/api/deletequery)

### Relationships (Entity Service)
- [saveMappedItems](/api/savemappeditems)
- [removeMappedItems](/api/removemappeditems)

### Definitions (Schema Manager)
- [getCommonPropertyDefs](/api/getcommonpropertydefs)
- [getEntityDef](/api/getentitydef)
- [queryEntityDefs](/api/queryentitydefs)
- [createEntityDef](/api/createentitydef)
- [updateEntityDef](/api/updateentitydef)
- [addProperty](/api/addproperty)
- [updateProperty](/api/updateproperty)
- [removeProperty](/api/removeproperty)
- [createOrUpdateSchema](/api/createorupdateschema)

### Functions and workflows (Workflow Service)
- [runWfFunction](/api/runwffunction)
- [testWfFunction](/api/testwffunction)
- [runWorkflow](/api/runworkflow)
- [startWorkflow](/api/startworkflow)
- [iterateTask](/api/iteratetask)
- [iterateOnce](/api/iterateonce)
- [submitWorkflowTask](/api/submitworkflowtask)

### Resource packs (Application Service)
- [addResourcePack](/api/addresourcepack)
- [installResourcePack](/api/installresourcepack)
- [getJobStatus](/api/getjobstatus)

## Full text

- [/llms-full.txt](/llms-full.txt): every guide and reference page in one file.

## Product

- [https://pikbase.com](https://pikbase.com)
- [https://workspace.pikbase.com](https://workspace.pikbase.com)