@modelrelay/sdk 1.3.2 → 1.10.3

package/README.md

@@ -47,7 +47,7 @@ import { CustomerTokenProvider, ModelRelay } from "@modelrelay/sdk";
 
 const tokenProvider = new CustomerTokenProvider({
   secretKey: process.env.MODELRELAY_API_KEY!,
-  request: { projectId: "proj_...", customerId: "cust_..." },
+  request: { customerId: "customer_..." },
 });
 
 const mr = new ModelRelay({ tokenProvider });
@@ -81,7 +81,7 @@ for await (const event of stream) {
 import { ModelRelay } from "@modelrelay/sdk";
 
 const mr = ModelRelay.fromSecretKey("mr_sk_...");
-const customer = mr.forCustomer("cust_abc123");
+const customer = mr.forCustomer("customer_abc123");
 
 const text = await customer.responses.text(
   "You are a helpful assistant.",
@@ -96,7 +96,7 @@ import { z } from "zod";
 import { ModelRelay, outputFormatFromZod } from "@modelrelay/sdk";
 
 const mr = ModelRelay.fromSecretKey("mr_sk_...");
-const customer = mr.forCustomer("cust_abc123");
+const customer = mr.forCustomer("customer_abc123");
 
 const schema = z.object({
   summary: z.string(),
@@ -122,7 +122,7 @@ You can also pass a single object to `textForCustomer`:
 
 ```ts
 const text = await mr.responses.textForCustomer({
-  customerId: "cust_abc123",
+  customerId: "customer_abc123",
   system: "You are a helpful assistant.",
   user: "Summarize Q4 results",
 });
@@ -309,7 +309,7 @@ for await (const event of stream) {
 
 ## Customer-Attributed Requests
 
-For metered billing, use `customerId()` — the customer's tier determines the model and `model` can be omitted:
+For metered billing, use `customerId()` — the customer's subscription tier determines the model and `model` can be omitted:
 
 ```ts
 const req = mr.responses
@@ -326,19 +326,57 @@ const stream = await mr.responses.stream(req);
 ```ts
 // Create/update customer
 const customer = await mr.customers.upsert({
-  tier_id: "tier-uuid",
   external_id: "your-user-id",
   email: "user@example.com",
 });
 
 // Create checkout session for subscription billing
-const session = await mr.customers.createCheckoutSession(customer.id, {
+const session = await mr.customers.subscribe(customer.customer.id, {
+  tier_id: "tier-uuid",
   success_url: "https://myapp.com/success",
   cancel_url: "https://myapp.com/cancel",
 });
 
 // Check subscription status
-const status = await mr.customers.getSubscription(customer.id);
+const status = await mr.customers.getSubscription(customer.customer.id);
+```
+
+## Error Handling
+
+Errors are typed so callers can branch cleanly:
+
+```ts
+import {
+  ModelRelay,
+  APIError,
+  TransportError,
+  StreamTimeoutError,
+  ConfigError,
+} from "@modelrelay/sdk";
+
+try {
+  const response = await mr.responses.text(
+    "claude-sonnet-4-20250514",
+    "You are helpful.",
+    "Hello!"
+  );
+} catch (error) {
+  if (error instanceof APIError) {
+    console.log("Status:", error.status);
+    console.log("Code:", error.code);
+    console.log("Message:", error.message);
+
+    if (error.isRateLimit()) {
+      // Back off and retry
+    } else if (error.isUnauthorized()) {
+      // Re-authenticate
+    }
+  } else if (error instanceof TransportError) {
+    console.log("Network error:", error.message);
+  } else if (error instanceof StreamTimeoutError) {
+    console.log("Stream timeout:", error.streamKind); // "ttft" | "idle" | "total"
+  }
+}
 ```
 
 ## Configuration
@@ -351,3 +389,14 @@ const mr = new ModelRelay({
   retry: { maxAttempts: 3 },
 });
 ```
+
+## Documentation
+
+For detailed guides and API reference, visit [docs.modelrelay.ai](https://docs.modelrelay.ai):
+
+- [First Request](https://docs.modelrelay.ai/getting-started/first-request) — Make your first API call
+- [Streaming](https://docs.modelrelay.ai/guides/streaming) — Real-time response streaming
+- [Structured Output](https://docs.modelrelay.ai/guides/structured-output) — Get typed JSON responses
+- [Tool Use](https://docs.modelrelay.ai/guides/tools) — Let models call functions
+- [Error Handling](https://docs.modelrelay.ai/guides/error-handling) — Handle errors gracefully
+- [Workflows](https://docs.modelrelay.ai/guides/workflows) — Multi-step AI pipelines