@nebula-ai/sdk 1.5.0 → 1.6.0-rc.0
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 +22 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,11 +7,20 @@ health.
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
+
# Stable
|
|
10
11
|
npm install @nebula-ai/sdk
|
|
11
|
-
#
|
|
12
|
-
|
|
12
|
+
# Preview (next iteration, RC versions)
|
|
13
|
+
npm install @nebula-ai/sdk@next
|
|
13
14
|
```
|
|
14
15
|
|
|
16
|
+
> **Pre-launch:** The public surface is still being shaped. Plain
|
|
17
|
+
> semver releases (`1.6.0`, `1.7.0`, …) are stable and published to
|
|
18
|
+
> the `latest` dist-tag. Iteration happens on the `next` dist-tag
|
|
19
|
+
> as pre-release versions (`1.6.0-rc.1`, `-rc.2`, …). Caret ranges
|
|
20
|
+
> like `^1.6.0` never auto-pick pre-releases — semver excludes them
|
|
21
|
+
> unless you explicitly opt in. Stable consumers are insulated from
|
|
22
|
+
> the iteration channel by default.
|
|
23
|
+
|
|
15
24
|
## Quick start
|
|
16
25
|
|
|
17
26
|
```ts
|
|
@@ -38,10 +47,17 @@ a `memory_id` is present); prefer the resource methods for everything else.
|
|
|
38
47
|
|
|
39
48
|
## Auth
|
|
40
49
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
50
|
+
Pass either `apiKey` (for Nebula API keys) or `bearerToken` (for JWTs)
|
|
51
|
+
when constructing the client. If you pass an opaque-looking token via
|
|
52
|
+
`apiKey` (one that isn't prefixed with `key_` or `neb_`), the DX layer
|
|
53
|
+
automatically routes it through the `Authorization: Bearer` header
|
|
54
|
+
instead — handy when your app exchanges a workspace token for the SDK
|
|
55
|
+
and doesn't want to think about which header to use.
|
|
56
|
+
|
|
57
|
+
```ts
|
|
58
|
+
new Nebula({ apiKey: process.env.NEBULA_API_KEY });
|
|
59
|
+
new Nebula({ bearerToken: process.env.NEBULA_BEARER_TOKEN });
|
|
60
|
+
```
|
|
45
61
|
|
|
46
62
|
## Errors
|
|
47
63
|
|