Skip to main content

​
SDKs Overview

Gumnut offers native SDKs that provide type-safe, idiomatic interfaces to the Gumnut API. Our SDKs handle authentication, request formatting, error handling, and response parsing, allowing you to focus on building your application.

​
Available SDKs

​
TypeScript/JavaScript

Our TypeScript SDK provides full type safety and works in both Node.js and browser environments.

​
Python

Our Python SDK provides a Pythonic interface with full type hints support.
Need an SDK in another language? Additional language SDKs can be made available on request. Contact us at www.gumnut.ai/support.

​
Common Features

All SDKs share these capabilities:
  • Authentication: API key and OAuth token support, environment variable configuration
  • Reliability: Automatic retries with exponential backoff, comprehensive error handling
  • File Handling: Multiple upload formats, stream support for large files
  • Pagination: Automatic pagination helpers and iterator patterns
  • Type Safety: Full type definitions and IDE autocompletion

​
Getting Started

​
1. Install

# TypeScript/JavaScript
npm install gumnut-sdk

# Python
pip install gumnut-sdk

​
2. Basic Usage

All SDKs follow similar patterns: 
// Initialize client
const client = new Gumnut({ apiKey: "your_key" });

// Upload an asset
const asset = await client.assets.create({ /* ... */ });

// Create an album
const album = await client.albums.create({ /* ... */ });

// Add to album
await client.albums.addAssets(album.id, [asset.id]);

​
Direct API Usage

If an SDK isn’t available for your language, you can use the REST API directly: 
curl -X GET https://api.gumnut.ai/api/assets \
  -H "Authorization: Bearer YOUR_API_KEY"