Kizaki
ReferenceInspire

Inspire Overview

Inspire is the declarative language that defines your application's data model, access model, and platform features.

Inspire is the source of truth for:

  • entities and relations
  • auth and principal fields
  • access policies
  • namespaces
  • routes and API keys
  • triggers, effects, and schedules
  • billing, file storage, and network policy

In practice, Inspire is where you declare the platform-level facts about your application. It is not only a modeling language for tables. It is the contract that connects data shape, access control, generated surfaces, and runtime behavior.

Example

auth {
  providers: [email],
}

entity Todo {
  title: string,
  completed: boolean = false,
  ownerId: __User.id,

  @grant read, write, delete where resource.ownerId == principal.id
}

Use the rest of the Inspire reference for the exact syntax of each feature.

How To Use This Reference

Use the Inspire reference when you need exact answers to questions like:

  • where does this concern belong in the schema
  • what syntax does this declaration use
  • what behavior does it affect
  • what is the canonical example for this feature

If the concern changes how the platform behaves around data, access, routes, files, billing, or background work, it probably belongs in Inspire.

On this page