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
  • validation types for function inputs

Inspire declares the platform-level facts about your application. It 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
}

For the full auth {} surface, see Inspire Auth.

How To Use This Reference

Consult the Inspire reference for questions like:

  • Where does this concern belong in the schema?
  • What syntax does this declaration use?
  • What behavior does it affect?

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

On this page