API Client

Lower-level promise-based API functions for direct backend access when hooks don't provide enough control.

import { listWorkspaces, executeQuery, uploadFile, flowstackFetch } from 'flowstack-sdk'

Direct API access — use these when you need lower-level control than the hooks provide.

All functions take (credentials, ...params, config?) and return Promise<ApiResponse<T>>. They cover auth (login, register), workspaces (listWorkspaces, createWorkspace, getWorkspace), datasets (listDatasets, getDataset, getDatasetPreview, deleteDataset), visualizations & reports (listVisualizations, listReports), models & scripts (listModels, getModel, listScripts), data sources (listDataSources, createDataSource, testDataSource, deleteDataSource), sites (listSites, getSite, createSite, addSiteFile, publishStagedSite, deleteSite), user management (listUsers, getUser, updateUser, deleteUser, suspendUser, reactivateUser, getUserActivity, getUserStats, checkAdminPermissions), conversations (getConversationHistory), query (executeQuery, executeQueryWithConfig), file upload (uploadFile), and the low-level flowstackFetch escape hatch.

Signature

fn(credentials, ...params, config?): Promise<ApiResponse<T>>

Examples

import {
  // Auth
  login, register,
  // Workspaces
  listWorkspaces, createWorkspace, getWorkspace,
  // Datasets
  listDatasets, getDataset, getDatasetPreview, deleteDataset,
  // Visualizations & Reports
  listVisualizations, listReports,
  // Models & Scripts
  listModels, getModel, listScripts,
  // Data Sources
  listDataSources, createDataSource, testDataSource, deleteDataSource,
  // Sites
  listSites, getSite, createSite, addSiteFile, publishStagedSite, deleteSite,
  // User Management
  listUsers, getUser, updateUser, deleteUser, suspendUser, reactivateUser,
  getUserActivity, getUserStats, checkAdminPermissions,
  // Conversations
  getConversationHistory,
  // Query
  executeQuery, executeQueryWithConfig,
  // File Upload
  uploadFile,
  // Low-level
  flowstackFetch,
} from 'flowstack-sdk';

See also

flowstackFetch · useQuery · useWorkspace · useDatasets

Source: README.md#api-client · Also available in llms-full.txt and registry.json.