CredentialsResource: Manage Baserow Credentials

The CredentialsResource on figranium.credentials lets you manage output credentials for the Figranium platform. Currently, the only supported provider is Baserow. You can create credentials, update their name or configuration, delete them, and browse Baserow metadata such as databases and tables.

import { Figranium } from "@figranium/sdk";

const figranium = new Figranium({ apiKey: process.env.FIGRANIUM_API_KEY! });

Every method accepts an optional final RequestOptions argument with signal, timeoutMs, and headers. See Request options for details.

Methods

list

list(options?: RequestOptions): Promise<Credential[]>

Fetch all stored credentials. Returns an array of Credential objects.

HTTP endpoint: GET /api/credentials

list-credentials.ts

const credentials = await figranium.credentials.list();
console.log(credentials);
// => [{ id: "cred_01", name: "Production Baserow", provider: "baserow", config: { baseUrl: "...", token: "..." } }]

create

create(input: CredentialInput, options?: RequestOptions): Promise<Credential>

Create a new credential. The CredentialInput shape requires a name, provider (currently only "baserow"), and a config object with baseUrl and token.

HTTP endpoint: POST /api/credentials

create-credential.ts

const credential = await figranium.credentials.create({
  name: "Production Baserow",
  provider: "baserow",
  config: {
    baseUrl: "https://baserow.example.com",
    token: process.env.BASEROW_TOKEN!,
  },
});

console.log(credential.id);

update

update(
  id: string,
  input: Partial<Pick<CredentialInput, "name" | "config">>,
  options?: RequestOptions
): Promise<Credential>

Update an existing credential’s name or configuration. Pass only the fields you want to change.

HTTP endpoint: PUT /api/credentials/:id

update-credential.ts

const updated = await figranium.credentials.update(credential.id, {
  name: "Staging Baserow",
  config: {
    baseUrl: "https://staging.baserow.example.com",
    token: process.env.STAGING_BASEROW_TOKEN!,
  },
});

delete

delete(id: string, options?: RequestOptions): Promise<{ ok: boolean }>

Remove a credential by ID. Returns an object with an ok field indicating success.

HTTP endpoint: DELETE /api/credentials/:id

delete-credential.ts

const result = await figranium.credentials.delete(credential.id);
console.log(result.ok);

baserowDatabases

baserowDatabases(id: string, options?: RequestOptions): Promise<Array<{ id: string; name: string; workspaceName: string }>>

List the Baserow databases accessible through a credential. Each entry includes the database id, name, and workspaceName.

HTTP endpoint: GET /api/credentials/:id/proxy/baserow/databases

list-databases.ts

const databases = await figranium.credentials.baserowDatabases(credential.id);

for (const db of databases) {
  console.log(`${db.name} (${db.workspaceName})`);
}

baserowTables

baserowTables(
  id: string,
  databaseId: string | number,
  options?: RequestOptions
): Promise<Array<{ id: string; name: string }>>

List the tables inside a Baserow database. Pass the credential ID and the database ID (from baserowDatabases).

HTTP endpoint: GET /api/credentials/:id/proxy/baserow/databases/:databaseId/tables

list-tables.ts

const tables = await figranium.credentials.baserowTables(credential.id, databases[0].id);

for (const table of tables) {
  console.log(`${table.name} (id: ${table.id})`);
}

Full Baserow workflow

This example creates a credential, lists databases, and then lists tables for the first database:

baserow-workflow.ts

const credential = await figranium.credentials.create({
  name: "My Baserow",
  provider: "baserow",
  config: {
    baseUrl: "https://baserow.example.com",
    token: process.env.BASEROW_TOKEN!,
  },
});

const databases = await figranium.credentials.baserowDatabases(credential.id);
if (databases.length === 0) {
  console.log("No databases found");
} else {
  const tables = await figranium.credentials.baserowTables(credential.id, databases[0].id);
  console.log(tables);
}

Types

`Credential`

interface Credential {
  id: string;
  name: string;
  provider: "baserow";
  config: { baseUrl: string; token: string };
}

`CredentialInput`

interface CredentialInput {
  name: string;
  provider: "baserow";
  config: { baseUrl: string; token: string };
}

Intro

Installation

Basics

Features

Agent Logic

API

JavaScript SDK

Integrations

Ops

Changelog

CredentialsResource: Manage Baserow Credentials

Methods

Full Baserow workflow

Types

`Credential`

`CredentialInput`

​Methods

​Full Baserow workflow

​Types

​Credential

​CredentialInput

Methods

Full Baserow workflow

Types

`Credential`

`CredentialInput`