@happyrobot-ai/sdk 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
# @happyrobot/sdk
|
|
1
|
+
# @happyrobot-ai/sdk
|
|
2
2
|
|
|
3
3
|
TypeScript SDK for the HappyRobot Public API.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @happyrobot/sdk
|
|
8
|
+
npm install @happyrobot-ai/sdk
|
|
9
9
|
# or
|
|
10
|
-
pnpm add @happyrobot/sdk
|
|
10
|
+
pnpm add @happyrobot-ai/sdk
|
|
11
11
|
# or
|
|
12
|
-
yarn add @happyrobot/sdk
|
|
12
|
+
yarn add @happyrobot-ai/sdk
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Quick Start
|
|
16
16
|
|
|
17
17
|
```ts
|
|
18
|
-
import { HappyRobotClient } from "@happyrobot/sdk";
|
|
18
|
+
import { HappyRobotClient } from "@happyrobot-ai/sdk";
|
|
19
19
|
|
|
20
20
|
const client = new HappyRobotClient({ apiKey: "sk_live_..." });
|
|
21
21
|
|
|
@@ -41,14 +41,14 @@ const client = new HappyRobotClient({
|
|
|
41
41
|
|
|
42
42
|
## Helpers
|
|
43
43
|
|
|
44
|
-
High-level convenience functions available via `@happyrobot/sdk/helpers`.
|
|
44
|
+
High-level convenience functions available via `@happyrobot-ai/sdk/helpers`.
|
|
45
45
|
|
|
46
46
|
### `triggerAndWait`
|
|
47
47
|
|
|
48
48
|
Trigger a workflow run and poll until it reaches a terminal status.
|
|
49
49
|
|
|
50
50
|
```ts
|
|
51
|
-
import { triggerAndWait } from "@happyrobot/sdk/helpers";
|
|
51
|
+
import { triggerAndWait } from "@happyrobot-ai/sdk/helpers";
|
|
52
52
|
|
|
53
53
|
const { run, sessions } = await triggerAndWait(client, {
|
|
54
54
|
workflowId: "my-workflow",
|
|
@@ -67,7 +67,7 @@ console.log(run.status); // "completed" | "failed" | "canceled" | ...
|
|
|
67
67
|
Create a voice agent workflow from a template with optional publishing.
|
|
68
68
|
|
|
69
69
|
```ts
|
|
70
|
-
import { createVoiceAgent } from "@happyrobot/sdk/helpers";
|
|
70
|
+
import { createVoiceAgent } from "@happyrobot-ai/sdk/helpers";
|
|
71
71
|
|
|
72
72
|
const { workflow, publishResult } = await createVoiceAgent(client, {
|
|
73
73
|
name: "Sales Agent",
|
|
@@ -85,7 +85,7 @@ const { workflow, publishResult } = await createVoiceAgent(client, {
|
|
|
85
85
|
Create any workflow from a template with custom inputs.
|
|
86
86
|
|
|
87
87
|
```ts
|
|
88
|
-
import { createFromTemplate } from "@happyrobot/sdk/helpers";
|
|
88
|
+
import { createFromTemplate } from "@happyrobot-ai/sdk/helpers";
|
|
89
89
|
|
|
90
90
|
const { workflow } = await createFromTemplate(client, {
|
|
91
91
|
template: "voice-agent",
|
|
@@ -758,7 +758,7 @@ for await (const workflow of client.workflows.listAll({ folder_id: "..." })) {
|
|
|
758
758
|
## Error Handling
|
|
759
759
|
|
|
760
760
|
```ts
|
|
761
|
-
import { ApiError, AuthenticationError, NotFoundError } from "@happyrobot/sdk";
|
|
761
|
+
import { ApiError, AuthenticationError, NotFoundError } from "@happyrobot-ai/sdk";
|
|
762
762
|
|
|
763
763
|
try {
|
|
764
764
|
const wf = await client.workflows.get("nonexistent");
|