DiscordDiscord (opens in a new tab)@keelteam@keelteam (opens in a new tab)ContactContact (opens in a new tab)
GitHubGitHub (opens in a new tab)
  • Introduction
  • Get Started
  • Quickstart
  • What is Keel?
  • Local Development
  • Concepts
  • Models
  • Actions
  • Identity
  • Permissions
  • Functions
    • Action hooks
    • Custom functions
    • Auth hooks
    • Functions SDK
      • Model API
      • Database API
  • Jobs
  • Events
  • Files
  • Routes
  • Reference
  • Schema
  • Features
  • Internal tools
      • Get actions
      • List actions
      • Update actions
      • Create actions
      • Delete actions
    • Relationships
    • Lookup Input Fields
    • Linked Fields
    • Linked Actions
    • Getting Started
      • Single Sign-On
      • ID Token
      • Password
    • Tokens
    • Configuration
    • Providers
    • Endpoints
  • APIs
    • Generated Client
    • GraphQL API
    • JSON API
  • Environment Variables
  • Secrets
  • keelconfig.yaml
  • Self-hosting
  • Seeding data
  • Tools
  • CLI
  • Guides
  • Testing
  • Integrating Stripe
  • Tutorials
  • Basic Tutorial
  • Advanced Tutorial
    • Setup
    • Building the Keel Schema
    • User Model
    • in operator
    • Team Model
    • Team Membership Model
    • Document Model
    • Profile Image Model
    • Custom Function
    • Using Secrets
    • Deploy to Keel
  • Internal Tools
    • Setup
    • Listing data
    • Creating data
    • Single records
    • Modifying data
    • Usage
    • Wrapping up
  • Next.js (App Router)
  • Remix
  • Nuxt
  • Vue
  • Misc
  • Release Notes
    • 0.411 (24 Apr 2025)
    • 0.407 (06 Mar 2025)
    • 0.406 (28 Feb 2025)
    • 0.404 (25 Feb 2025)
    • 0.402 (21 Feb 2025)
    • 0.401 (17 Feb 2025)
    • 0.400 (03 Feb 2025)
    • 0.399 (29 Jan 2025)
    • 0.397 (27 Nov 2024)
    • 0.396 (30 Oct 2024)
    • 0.395 (04 Oct 2024)
    • 0.393 (21 Aug 2024)
    • 0.389 (29 July 2024)
    • 0.388 (12 July 2024)
    • 0.387 (21 June 2024)
    • 0.386 (07 May 2024)
    • 0.384 (22 Apr 2024)
    • 0.382 (03 Apr 2024)
    • 0.380 (19 Feb 2024)
    • 0.379 (12 Feb 2024)
    • 0.378 (02 Feb 2024)
    • 0.376 (17 Jan 2024)
    • 0.374 (18 Dec 2023)
    • 0.373 (27 Nov 2023)
    • 0.372 (15 Nov 2023)
    • 0.371 (09 Nov 2023)
    • 0.370 (26 Oct 2023)
    • 0.369 (20 Oct 2023)
    • 0.368 (29 Sep 2023)
    • 0.365 (01 Sep 2023)
  • Introduction
  • Get Started
  • Quickstart
  • What is Keel?
  • Local Development
  • Concepts
  • Models
  • Actions
  • Identity
  • Permissions
  • Functions
    • Action hooks
    • Custom functions
    • Auth hooks
    • Functions SDK
      • Model API
      • Database API
  • Jobs
  • Events
  • Files
  • Routes
  • Reference
  • Schema
  • Features
  • Internal tools
      • Get actions
      • List actions
      • Update actions
      • Create actions
      • Delete actions
    • Relationships
    • Lookup Input Fields
    • Linked Fields
    • Linked Actions
    • Getting Started
      • Single Sign-On
      • ID Token
      • Password
    • Tokens
    • Configuration
    • Providers
    • Endpoints
  • APIs
    • Generated Client
    • GraphQL API
    • JSON API
  • Environment Variables
  • Secrets
  • keelconfig.yaml
  • Self-hosting
  • Seeding data
  • Tools
  • CLI
  • Guides
  • Testing
  • Integrating Stripe
  • Tutorials
  • Basic Tutorial
  • Advanced Tutorial
    • Setup
    • Building the Keel Schema
    • User Model
    • in operator
    • Team Model
    • Team Membership Model
    • Document Model
    • Profile Image Model
    • Custom Function
    • Using Secrets
    • Deploy to Keel
  • Internal Tools
    • Setup
    • Listing data
    • Creating data
    • Single records
    • Modifying data
    • Usage
    • Wrapping up
  • Next.js (App Router)
  • Remix
  • Nuxt
  • Vue
  • Misc
  • Release Notes
    • 0.411 (24 Apr 2025)
    • 0.407 (06 Mar 2025)
    • 0.406 (28 Feb 2025)
    • 0.404 (25 Feb 2025)
    • 0.402 (21 Feb 2025)
    • 0.401 (17 Feb 2025)
    • 0.400 (03 Feb 2025)
    • 0.399 (29 Jan 2025)
    • 0.397 (27 Nov 2024)
    • 0.396 (30 Oct 2024)
    • 0.395 (04 Oct 2024)
    • 0.393 (21 Aug 2024)
    • 0.389 (29 July 2024)
    • 0.388 (12 July 2024)
    • 0.387 (21 June 2024)
    • 0.386 (07 May 2024)
    • 0.384 (22 Apr 2024)
    • 0.382 (03 Apr 2024)
    • 0.380 (19 Feb 2024)
    • 0.379 (12 Feb 2024)
    • 0.378 (02 Feb 2024)
    • 0.376 (17 Jan 2024)
    • 0.374 (18 Dec 2023)
    • 0.373 (27 Nov 2023)
    • 0.372 (15 Nov 2023)
    • 0.371 (09 Nov 2023)
    • 0.370 (26 Oct 2023)
    • 0.369 (20 Oct 2023)
    • 0.368 (29 Sep 2023)
    • 0.365 (01 Sep 2023)
  • Discord (opens in a new tab)
  • @keelteam (opens in a new tab)
  • Contact (opens in a new tab)
(opens in a new tab)
Functions
Functions SDK

TypeScript SDK

The @teamkeel/sdk package is generated based on your schema and contains type-safe APIs for interacting with your database as well as other utilities. This SDK is available to functions within Keel.

  • Model API
  • Database API
Auth hooksModel API

© Planko Ltd 2025