terse-sdk
v0.1.47
Published
TypeScript SDK for building workflows on the [Terse](https://useterse.ai) platform.
Downloads
3,404
Readme
terse-sdk
TypeScript SDK for building workflows on the Terse platform.
Terse is a code-first AI workflow platform. You write workflows in TypeScript, mix deterministic tool calls with agentic loops, and deploy serverlessly. Full docs at docs.useterse.ai.
Install
npm install terse-sdk zodzod is used for structured output schemas.
The fastest way to get started is npm install -g terse-cli && terse init my-project. The CLI scaffolds the project, installs terse-sdk, and generates src/terse.generated.ts for you. See the quickstart.
Example
import { createJob, TerseAgent, type GithubPRTrigger } from "terse-sdk"
import { GitHub, Repos, Slack, SlackChannel } from "./terse.generated"
createJob({
name: "Summarize PR and post to Slack",
triggers: [GitHub.onPROpened({ repo: Repos.MyOrg.MyRepo })],
onTrigger: async (event: GithubPRTrigger) => {
const agent = TerseAgent.create({
prompt: "Summarize incoming PRs and post a Block Kit message to Slack.",
skills: [
GitHub.skill({ repos: [Repos.MyOrg.MyRepo] }),
Slack.skill({ channel: SlackChannel.Engineering })
]
})
// Deterministic tool call. Strongly typed.
const message = await agent.tools.slack.sendMessage({
channelId: SlackChannel.Engineering.channelId,
message: `New PR from ${event.sender.login}`
})
// Hand off to the agent for judgment.
await agent.runAndWait(`
Summarize this PR: ${event.formatForAgentRunner()}
Reply in a thread to ts: ${message.message_ts}.
`)
}
})Core concepts
| Concept | What it is |
|---|---|
| createJob() | Registers a workflow at module load time. |
| TerseAgent.create() | Build an agent inside onTrigger with prompt, skills, and toolApprovals. |
| agent.run() | Stream the model run as an async iterable. |
| agent.runAndWait() | Run to completion. Pass a zod schema for structured output. |
| agent.tools.* | Generated, deterministic wrappers. Call directly to bypass the LLM. |
| Triggers | GitHub.onPROpened(), Schedule.cron(), Webhook.onRequest<Body>(), etc. |
| Skills | Integration configs that scope tools available to the agent. |
The trigger builders, skill constructors, and agent.tools.* wrappers come from src/terse.generated.ts, which is produced by terse generate. Do not edit it by hand.
Full reference: docs.useterse.ai/reference/typescript-sdk.
Environment
| Variable | Description |
|---|---|
| TERSE_API_KEY | Required at runtime. The CLI also stores a key per user via terse login. |