SDKs
The intended developer experience for the platform is SDK-first for backend integrations. The current app already exposes the underlying resource model, but the long-term product should let developers manage prompts, tools, agents, runs, realtime sessions, API keys, and service keys through polished client libraries.
This page is intentionally target-state documentation. It describes the SDK experience the product is aiming for, not a fully shipped SDK catalog.
Why SDKs
SDKs should make the platform easier to adopt by:
- handling authentication and organization scoping consistently
- exposing typed resource clients for prompts, tools, agents, and runs
- normalizing error handling across endpoints
- making backend automation and CI workflows easier to write
Node SDK
Node.js and TypeScript are the primary planned SDK targets.
Install the planned Node SDK
npm install @saas-ai/platform
Initialize the planned client
import { AIPlatformClient } from '@saas-ai/platform'
const client = new AIPlatformClient({
apiKey: process.env.SAAS_AI_API_KEY,
organizationId: 'org_123',
})
Planned resource clients
- Name
client.prompts- Description
Create prompts, manage versions, preview composition, publish versions, and execute runs.
- Name
client.tools- Description
Create tools, inspect schemas, and attach tools to prompt versions.
- Name
client.agents- Description
Create multi-step agents, publish versions, run agents, and inspect run history.
- Name
client.voiceAgents- Description
Manage realtime agents, sessions, and handoff behavior.
- Name
client.runs- Description
Inspect prompt runs, agent runs, and realtime sessions from one client surface.
Planned prompt workflow
const prompt = await client.prompts.create({
name: 'Returns eligibility',
description: 'Decide whether an order qualifies for return',
})
const version = await client.prompts.createVersion(prompt.id, {
systemPrompt: 'You are a returns assistant.',
variablesSchema: {
type: 'object',
properties: {
orderId: { type: 'string' },
},
required: ['orderId'],
},
})
await client.prompts.publish(prompt.id, version.id)
SDK roadmap
Node.js
The planned first-party TypeScript SDK for backend services, workers, and CI automation.
Ruby
Planned SDK guidance for Rails apps integrating prompts, runs, and service-key automation.
PHP
Planned SDK coverage for backend integrations that need prompt execution and observability APIs.