Skip to main content

SDK & Developer

The SimplAI SDK is the developer surface for integrating SimplAI into your own application code — without the orchestration complexity (polling, retries, streaming, scheduling) you'd have to write against the raw API.

This section covers:

  • Python SDK — the SDK reference: workflow execution, agent chat, streaming, bulk runs, scheduling, traces, billing.
  • Future extensions — the SDK is built Python-first today; JS/TS support is planned for a future release.

When to reach for the SDK​

  • You're embedding SimplAI in production application code and need typed, idiomatic interfaces.
  • You're running bulk jobs programmatically over a list of inputs.
  • You need to stream agent responses to your own UI.
  • You want scheduled workflow runs without re-implementing cron handling yourself.

When to use the REST API instead​

  • You're calling SimplAI from a non-Python language that doesn't have an SDK yet.
  • You're doing a one-off integration test or a quick curl.
  • You're integrating from a low-code platform (Zapier, n8n) that already speaks HTTP.

See Connections & Integrations → REST API for the raw HTTP endpoints.

Authentication​

The SDK abstracts authentication — it accepts an API key (and optionally OAuth credentials in the future). Generate keys from the Deployment tab of any Application, scoped to that Application; or use account-level keys for broader access.

Versioning​

The SDK is versioned independently of the platform. Pin a specific SDK version in your dependencies; the SDK supports backward compatibility across recent platform versions so you don't have to upgrade lockstep with every SimplAI release.

What's in scope (today)​

  • Workflow execution — sync, async, scheduled, bulk.
  • Agent chat — non-streaming and streaming.
  • Observability — fetch execution traces by ID.
  • Billing — fetch token usage and execution cost data.

What's out of scope (today)​

  • Workflow definition authoring in code — workflows are still built in Studio. The SDK invokes published applications.
  • Billing computation — the SDK retrieves billing data; it doesn't compute charges.
  • UI primitives — the SDK is non-visual.