@keelteam@keelteam (opens in a new tab)ContactContact (opens in a new tab)
  • Introduction
  • Get Started
  • Quickstart
  • What is Keel?
  • Local Development
  • Schema
  • Models
  • Actions
  • Identity
  • Permissions
  • Functions
    • Action hooks
    • Custom functions
    • Auth hooks
    • Functions SDK
      • Model API
      • Database API
      • Transactions
      • Error Handling
  • Events
  • Files
  • Routes
  • Flows
    • Writing flows
    • Function steps
    • UI steps
      • Display.banner
      • Display.code
      • Display.divider
      • Display.file
      • Display.grid
      • Display.header
      • Display.image
      • Display.keyvalue
      • Display.list
      • Display.markdown
      • Display.table
      • Input.boolean
      • Input.datagrid
      • Input.datepicker
      • Input.number
      • Input.scan
      • Input.text
      • Interactive.picklist
      • Interactive.print
      • Iterator
      • Select.one
      • Select.table
    • Completion
    • Permissions
    • Scheduling
    • Best practices
  • Jobs
  • Environment Variables
  • Secrets
  • Console
  • Overview
  • Tools
    • Configuration
    • Input Fields
    • Response Fields
    • Field Formatting
    • Display Layouts
      • Table
      • Inbox
      • Kanban
      • Gallery
    • Tool Linking
    • Embedded Tools
    • JSON Reference
  • Spaces
    • Creating Spaces
    • Managing Spaces
    • External Links
    • Metrics
    • Copying Spaces
    • Members & Access
  • Hardware
    • Printing
    • Scanning
  • Database Explorer
  • Monitoring
  • Builds
  • Settings
  • Reference
  • Schema Reference
  • Expressions
  • CLI
  • APIs
    • Generated Client
    • GraphQL API
    • JSON API
  • keelconfig.yaml
  • Guides
    • Getting Started
      • Single Sign-On
      • ID Token
      • Password
    • Tokens
    • Configuration
    • Providers
    • Endpoints
  • Testing
  • Seeding Data
  • Integrating Stripe
  • Self-hosting
  • Misc
  • Release Notes
    • 0.413 (13 May 2025)
    • 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
  • Schema
  • Models
  • Actions
  • Identity
  • Permissions
  • Functions
    • Action hooks
    • Custom functions
    • Auth hooks
    • Functions SDK
      • Model API
      • Database API
      • Transactions
      • Error Handling
  • Events
  • Files
  • Routes
  • Flows
    • Writing flows
    • Function steps
    • UI steps
      • Display.banner
      • Display.code
      • Display.divider
      • Display.file
      • Display.grid
      • Display.header
      • Display.image
      • Display.keyvalue
      • Display.list
      • Display.markdown
      • Display.table
      • Input.boolean
      • Input.datagrid
      • Input.datepicker
      • Input.number
      • Input.scan
      • Input.text
      • Interactive.picklist
      • Interactive.print
      • Iterator
      • Select.one
      • Select.table
    • Completion
    • Permissions
    • Scheduling
    • Best practices
  • Jobs
  • Environment Variables
  • Secrets
  • Console
  • Overview
  • Tools
    • Configuration
    • Input Fields
    • Response Fields
    • Field Formatting
    • Display Layouts
      • Table
      • Inbox
      • Kanban
      • Gallery
    • Tool Linking
    • Embedded Tools
    • JSON Reference
  • Spaces
    • Creating Spaces
    • Managing Spaces
    • External Links
    • Metrics
    • Copying Spaces
    • Members & Access
  • Hardware
    • Printing
    • Scanning
  • Database Explorer
  • Monitoring
  • Builds
  • Settings
  • Reference
  • Schema Reference
  • Expressions
  • CLI
  • APIs
    • Generated Client
    • GraphQL API
    • JSON API
  • keelconfig.yaml
  • Guides
    • Getting Started
      • Single Sign-On
      • ID Token
      • Password
    • Tokens
    • Configuration
    • Providers
    • Endpoints
  • Testing
  • Seeding Data
  • Integrating Stripe
  • Self-hosting
  • Misc
  • Release Notes
    • 0.413 (13 May 2025)
    • 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)
  • @keelteam (opens in a new tab)
  • Contact (opens in a new tab)
Question? Give us feedback → (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 2026