Skip to content

SDK overview

@abeauvois/platform-sdk exposes a single PlatformApiClient that composes one typed sub-client per vertical. Construct it once; every sub-client shares the same auth.

import { PlatformApiClient } from '@abeauvois/platform-sdk'
const client = new PlatformApiClient({
baseUrl: 'http://localhost:3000',
credentials: 'include', // browser, or use getToken for bearer auth
})

See Install the SDK for auth modes.

AccessorVertical
client.authsign in / up / out (syncs the token to every sub-client)
client.apiKeysAPI-key management
client.configruntime config
client.settingsuser + app settings
client.sourcesingestion source reads
client.jobsjobs, presets, schedules, queue stats
client.tasksthe /tasks kanban — every row the caller owns, including social/blog/link drafts and sales Deals, in one list (each carrying a channel)
client.quoteRequestquote requests
client.blogblog posts (admin + API-key public read)
client.artifactsdeprecated — a thin wrapper over client.tasks kept for existing callers (translates the legacy Artifact* wire shapes); new code should use client.tasks directly
client.observationsappend-only numeric time-series (the watch history)
client.skillsuser-authored pipeline skills
client.setSessionToken(token)
client.setSessionCookie(cookie)
client.getSessionToken()
client.clearSessionToken()

The most commonly used surface — jobs — is documented on the next page.