Create Framalab client

import { createFramalabClient } from "@dcmx-studio/framalab-sdk"

const client = createFramalabClient(options)

Options

string

required

The base URL of your Framalab panel. Trailing slashes are stripped automatically.

string

required

The gallery token for a specific project. Sent as X-Gallery-Token on every request. See Authentication to generate one.

Returns

A FramalabClient object with these methods:

Method	Returns	Async
`getProject()`	`GalleryProject`	Yes
`getPhotos()`	`GalleryPhoto[]`	Yes
`getCollections()`	`GalleryCollection[]`	Yes
`getCollection(id)`	`GalleryCollectionDetail`	Yes
`getMediaUrl(photoId, opts?)`	`string`	No

Singleton pattern

The client is a plain object — no connection is opened at creation time. Initialize once and reuse across your app.

lib/framalab.ts

import { createFramalabClient } from "@dcmx-studio/framalab-sdk"

export const framalab = createFramalabClient({
  baseUrl: process.env.FRAMALAB_URL!,
  token: process.env.FRAMALAB_TOKEN!,
})

app.ts

import { framalab } from "@/lib/framalab"

const photos = await framalab.getPhotos()

Get Started

SDK Reference

Concepts

Examples

Create Framalab client

Options

Returns

Singleton pattern

​Options

​Returns

​Singleton pattern

Options

Returns

Singleton pattern