Gestell Node SDK

A fully featured SDK with extensive code completion for interacting with the Gestell Platform. Compatible with both web and server side environments.

Quick Start

First, get an API Key from https://platform.gestell.ai. Then install @gestell/sdk:

npm install @gestell/sdk

Or...

bun add @gestell/sdk

Second, load the API Key into your terminal session, or, pass it into the SDK:

# Load it into your terminal session
export GESTELL_API_KEY = "..."

// Or, load it into the SDK library directly
import { Gestell } from '@gestell/sdk'

export const GESTELL_API_KEY = process.env.GESTELL_API_KEY || '...'
export const gestell = new Gestell({ key: GESTELL_API_KEY })

Gestell will also read and load these environment variables from a .env file.

Finally, start using the Gestell Platform SDK. The SDK can be used both on the client and server side. A public facing app should use it server side only due to the API Key being passed into the SDK and requests:

import Gestell from '@gestell/sdk';
import type { Document } from '@gestell/sdk/types';

const gestell = new Gestell()

const list: Document[] = await gestell.document.list({
  collectionId: ''
})

console.log(list)

Guide

You can review guides on common workflows and use cases for the Gestell Platform by going to https://gestell.ai/docs. There is a full guide to create, prompt, search and gather labels and tables at https://gestell.ai/docs/guide.

Review the Contributing Guidelines to see how to test and contribute features to the SDK.

Review the CHANGELOG to see updates and/or improvements to the SDK.