@blacklake-systems/sdk 0.1.0 → 0.1.1
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 +12 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -30,6 +30,8 @@ if (result.decision === 'allow') {
|
|
|
30
30
|
}
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
+
Sign up at [console.blacklake.systems](https://console.blacklake.systems) to get your API key. The console also provides a dashboard for managing agents, tools, policies, and reviewing the audit trail.
|
|
34
|
+
|
|
33
35
|
## API Reference
|
|
34
36
|
|
|
35
37
|
### `new BlackLake(config)`
|
|
@@ -37,7 +39,7 @@ if (result.decision === 'allow') {
|
|
|
37
39
|
| Option | Type | Default | Description |
|
|
38
40
|
|--------|------|---------|-------------|
|
|
39
41
|
| `apiKey` | `string` | — | Your BlackLake API key (required) |
|
|
40
|
-
| `baseUrl` | `string` | `http://localhost:3100` | API base URL |
|
|
42
|
+
| `baseUrl` | `string` | `http://localhost:3100` | API base URL. Use https://api.blacklake.systems for production. |
|
|
41
43
|
|
|
42
44
|
### `bl.govern(request)`
|
|
43
45
|
|
|
@@ -64,7 +66,7 @@ const result = await bl.govern({
|
|
|
64
66
|
await bl.agents.create({ name, environment, risk_classification, description?, approval_mode? });
|
|
65
67
|
await bl.agents.list({ environment?, status? });
|
|
66
68
|
await bl.agents.get(id);
|
|
67
|
-
await bl.agents.update(id, { name?, environment?, risk_classification?, status?, approval_mode? });
|
|
69
|
+
await bl.agents.update(id, { name?, description?, environment?, risk_classification?, status?, approval_mode? });
|
|
68
70
|
await bl.agents.suspend(id);
|
|
69
71
|
await bl.agents.activate(id);
|
|
70
72
|
await bl.agents.bindTool(agentId, toolId);
|
|
@@ -97,6 +99,13 @@ await bl.evaluations.list({ agent_id?, tool_id?, outcome?, limit?, offset? });
|
|
|
97
99
|
await bl.evaluations.get(id);
|
|
98
100
|
```
|
|
99
101
|
|
|
102
|
+
### `bl.organisation`
|
|
103
|
+
|
|
104
|
+
```typescript
|
|
105
|
+
await bl.organisation.get(); // fetch the current organisation (derived from the API key)
|
|
106
|
+
await bl.organisation.delete(confirmation); // permanently delete the organisation; pass the organisation's exact name as confirmation
|
|
107
|
+
```
|
|
108
|
+
|
|
100
109
|
### Error Handling
|
|
101
110
|
|
|
102
111
|
```typescript
|
|
@@ -113,4 +122,4 @@ try {
|
|
|
113
122
|
|
|
114
123
|
## Documentation
|
|
115
124
|
|
|
116
|
-
Full documentation at [blacklake.systems/
|
|
125
|
+
Full documentation at [blacklake.systems/docs](https://blacklake.systems/docs).
|