FluxSave SDK Documentation

Install

Install the SDK with your package manager of choice.

npm install @fluxsave/sdk

pip install fluxsave-sdk

composer require fluxsave/sdk

Authentication

All requests use API key + secret headers. You can set them in the constructor. The Node SDK also supports setAuth for runtime updates.

const client = new FluxsaveClient({
  baseUrl: 'https://fluxsaveapi.lutheralien.com',
  apiKey: 'fs_123',
  apiSecret: 'sk_456',
});

client.setAuth('fs_new', 'sk_new');

from fluxsave_sdk import FluxsaveClient

client = FluxsaveClient(
    base_url='https://fluxsaveapi.lutheralien.com',
    api_key='fs_123',
    api_secret='sk_456',
)

<?php

use Fluxsave\FluxsaveClient;

$client = new FluxsaveClient(
    'https://fluxsaveapi.lutheralien.com',
    'fs_123',
    'sk_456'
);

SDKs

Each SDK is open source with its own repo, changelog, and examples.

Node + TypeScript

Dual ESM/CJS package published to npm.

Python

Requests-based client published to PyPI.

PHP

Composer package for server-side workflows.

Upload

Upload a single file or multiple files. Image transforms are optional.

// Single file
await client.uploadFile(file, {
  name: 'marketing-hero',
  transform: true,
});

// Multiple files
await client.uploadFiles([
  { file: image1, filename: 'one.png' },
  { file: image2, filename: 'two.png' },
]);

# Single file
client.upload_file('./photo.png', name='marketing-hero', transform=True)

# Multiple files
client.upload_files([
    './one.png',
    './two.png',
], transform=False)

// Single file
$client->uploadFile('./photo.png', 'marketing-hero', true);

// Multiple files
$client->uploadFiles([
    './one.png',
    './two.png',
], 'campaign-batch', false);

List & delete

Fetch files and remove them by ID.

const list = await client.listFiles();
const first = list.data[0];

if (first) {
  await client.deleteFile(first._id || first.fileId);
}

files = client.list_files()
first = files['data'][0] if files['data'] else None

if first:
    client.delete_file(first.get('_id') or first.get('fileId'))

$list = $client->listFiles();
$first = $list['data'][0] ?? null;

if ($first) {
    $client->deleteFile($first['_id'] ?? $first['fileId']);
}

Errors

Errors throw FluxsaveError with status and data for easier debugging.

try {
  await client.uploadFile(file);
} catch (err) {
  if (err instanceof FluxsaveError) {
    console.log(err.status, err.message);
  }
}

from fluxsave_sdk import FluxsaveError

try:
    client.upload_file('./photo.png')
except FluxsaveError as err:
    print(err.status, err.message)

try {
    $client->uploadFile('./photo.png');
} catch (FluxsaveError $err) {
    echo $err->getCode() . ' ' . $err->getMessage();
}

Examples

Browser upload

const file = input.files[0];
await client.uploadFile(file);

Node upload

import { readFile } from 'node:fs/promises';
import { fileFromBuffer } from '@fluxsave/sdk';

const buffer = await readFile('./logo.png');
const file = fileFromBuffer(buffer, 'logo.png', 'image/png');
await client.uploadFile(file);

SDK config

Control timeouts and retry behavior for flaky networks.

const client = new FluxsaveClient({
  baseUrl: 'https://fluxsaveapi.lutheralien.com',
  apiKey: 'fs_xxx',
  apiSecret: 'sk_xxx',
  timeoutMs: 30000,
  retry: { retries: 2, retryDelayMs: 400 },
});

client = FluxsaveClient(
    base_url='https://fluxsaveapi.lutheralien.com',
    api_key='fs_xxx',
    api_secret='sk_xxx',
    timeout=30,
)

$client = new FluxsaveClient(
    'https://fluxsaveapi.lutheralien.com',
    'fs_xxx',
    'sk_xxx'
);

Changelog

0.1.0

Initial SDK release
Uploads, listing, updates, metrics
Retries + timeout support