Edictum

SDK Compatibility

Current compatibility notes for SDKs that connect to edictum-api.

AI Assistance

Right page if: you want the current compatibility floor for server-backed SDK usage. Wrong page if: you want the retired /api/v1/bundles contract from the old server stack. Gotcha: the current public API is the canonical /v1 ruleset-first surface.

The current compatibility contract is the canonical /v1 API surface.

Shared Expectations

All server-backed SDKs depend on:

  • workspace API keys with the edk_ prefix
  • ruleset fetch from /v1/rulesets/{name}/current
  • SSE updates from /v1/stream
  • event ingest to POST /v1/events
  • approval routes under /v1/approvals
  • session state under /v1/sessions/*

Current Language-Specific Notes

Python

  • Edictum.from_server() supports explicit bundle_name
  • Python also supports server-assigned mode when bundle_name=None

TypeScript

  • package is @edictum/server
  • createServerGuard() is the entry point
  • the current canonical /v1 path requires bundleName

Go

  • the server package handles server-backed rulesets, approvals, and state
  • Go examples should point at api.edictum.ai, not the retired console stack

Not Current

These old contracts are not the current public API:

  • /api/v1/bundles
  • /api/v1/deployments
  • /api/v1/bundles/evaluate
  • old assignment-rule discovery endpoints

Use API Reference and Connecting Agents as the source of truth.

Last updated on

On this page

Shared ExpectationsCurrent Language-Specific NotesPythonTypeScriptGoNot Current