@ether-os/os-sdk

TypeScript client for the Ether Harness API (/api/harness/*).

Install

npm install @ether-os/os-sdk

Monorepo dev (link from ether-core):

npm install file:../ether-core/packages/ether-os-sdk

Usage

import { EtherOsClient } from "@ether-os/os-sdk";

const client = new EtherOsClient({
  baseUrl: process.env.ETHER_API_BASE_URL!,
  token: process.env.ETHER_TOKEN!,
  appId: "ether-code",
});

const claim = await client.claimExecution("task_abc");
const context = await client.fetchContext("task_abc");
await client.reportStep("task_abc", {
  run_id: claim.run_id,
  phase: "coding_agent",
  user_message: "Making the changes…",
});
await client.submitResult("task_abc", {
  run_id: claim.run_id,
  status: "submitted",
  agent_status: "Opened PR #42",
  artifact: {
    pr: { number: 42, branch: "ether/task_abc", url: "https://github.com/acme/repo/pull/42" },
    agent_status: "Opened PR #42",
  },
});

OpenAPI reference: ether-core/docs/openapi/harness-v1.yaml.