openpond-sdk 0.0.11 → 0.0.13

package/README.md

@@ -119,6 +119,25 @@ await openpond.workflows.runNow(workflow.scheduleId);
 await openpond.workflows.update(workflow.scheduleId, { enabled: false });
 ```
 
+An external product can also let OpenPond own recurrence while keeping the
+work itself inside that product. External callbacks are created disabled by
+default by the caller, carry only an opaque external reference, and receive a
+verifiable Saved Work run identity when OpenPond fires them:
+
+```ts
+await openpond.workflows.create({
+  name: "Daily account review",
+  prompt: "Run the account-owned daily review.",
+  recurrence,
+  enabled: false,
+  target: {
+    kind: "external_callback",
+    callbackUrl: "https://app.example.com/api/workflows/openpond-callback",
+    externalReference: "opaque_binding_id",
+  },
+});
+```
+
 `openpond.workflows` is distinct from `openpond.sandboxes.createSchedule()`. Workflows schedule model-driven Work and create normal Work conversations and run history. Raw sandbox schedules execute a declared sandbox command or action.
 
 ## Project Actions
@@ -213,6 +232,34 @@ await openpond.work.deleteSandbox(sandboxId);
 
 The sandbox's 15-minute idle timeout is crash protection, not the normal successful-turn cleanup path. Use conservative budgets and application-level retention. API keys, provider credentials, and bypass secrets must remain in server-side configuration.
 
+## Model Projects and training
+
+The SDK exposes dependency-light contracts and API clients without importing
+the OpenPond application server:
+
+```ts
+import {
+  ModelProjectSchema,
+  createModelProjectsClient,
+} from "openpond-sdk/model-projects";
+import {
+  TrainingJobSubmissionSchema,
+  createTrainingClient,
+} from "openpond-sdk/training";
+```
+
+A Model Project is the mutable authoring object and owns one current training
+setup. Tasksets, Harnesses, evidence, Jobs, and Model Versions remain separate
+resources connected by immutable references. Submitting training snapshots the
+exact Project revision into an immutable Job; the Job is the durable Run
+identity and explicit approval is captured for that submission only.
+
+`createModelProjectsClient` synchronizes and reads hosted Project projections.
+`createTrainingClient` reads capabilities and creates or observes immutable
+Jobs, including Project-filtered Run history. These clients require an
+authenticated server-side API context; the schemas themselves contain no
+database, provider, credential, Electron, or UI dependencies.
+
 ## Development
 
 From the OpenPond monorepo: