@curvet/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Curvet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,160 @@
+# @curvet/sdk
+
+Official TypeScript SDK for the [Curvet](https://curvet.ai) Unified Playground API — chat, image, and video generation across multiple providers (OpenAI, Anthropic, Perplexity, DeepInfra) with **one API key and one balance**.
+
+```ts
+import { Curvet } from "@curvet/sdk";
+
+const curvet = new Curvet({ appKey: process.env.CURVET_APP_KEY });
+
+const { response } = await curvet.chat.create({
+  model: "gpt-4o-mini",
+  messages: [{ role: "user", content: "Write a tagline for a freelance marketplace." }],
+});
+console.log(response);
+```
+
+## Install
+
+```bash
+npm install @curvet/sdk
+```
+
+Requires Node 18+ (uses the built-in `fetch`). For older runtimes, pass a `fetch` implementation.
+
+## Authentication
+
+Get an **App Key** from the Curvet Developer Portal (with Playground API access enabled). Provide it directly or via the `CURVET_APP_KEY` environment variable.
+
+```ts
+const curvet = new Curvet({ appKey: "cvt_app_..." });
+// or: export CURVET_APP_KEY=cvt_app_...  then  new Curvet()
+```
+
+## Usage
+
+### Chat
+
+```ts
+const res = await curvet.chat.create({
+  model: "claude-sonnet-4-6",
+  messages: [
+    { role: "system", content: "You are concise." },
+    { role: "user", content: "Explain vector databases in one sentence." },
+  ],
+  temperature: 0.7,
+  maxTokens: 200,
+});
+console.log(res.response, res.usage.credits);
+```
+
+### Image
+
+```ts
+const img = await curvet.image.generate({
+  model: "flux-2-klein-4b",
+  prompt: "An astronaut riding a unicorn on Mars, cinematic",
+  size: "1024x1024", // single field — not width/height
+});
+console.log(img.imageUrl);
+```
+
+### Video (async, handled for you)
+
+Video runs as a background job. `generate()` submits **and polls to completion** — you just `await` it:
+
+```ts
+const video = await curvet.video.generate(
+  { model: "wan-2.2", prompt: "Neon Tokyo street in the rain", mode: "text_to_video" },
+  { onProgress: (pct) => console.log(`${pct}%`) },
+);
+console.log(video.mediaUrl);
+```
+
+Prefer fire-and-forget? Submit and poll yourself:
+
+```ts
+const job = await curvet.video.submit({ model: "wan-2.2", prompt: "..." });
+if (job.status !== "completed") {
+  const done = await curvet.jobs.handle(job.jobId!).wait();
+  console.log(done.mediaUrl);
+}
+// ...or check once later:
+const status = await curvet.jobs.retrieve(job.jobId!);
+```
+
+### Models & balance
+
+```ts
+const chatModels = await curvet.models.list({ type: "chat" });
+const balance = await curvet.balance.get();
+```
+
+## Errors
+
+Every failure throws a typed subclass of `CurvetError`:
+
+```ts
+import { InsufficientBalanceError, RateLimitError, AuthError } from "@curvet/sdk";
+
+try {
+  await curvet.image.generate({ model: "flux-2-klein-4b", prompt: "..." });
+} catch (err) {
+  if (err instanceof InsufficientBalanceError) {
+    console.error(`Need ${err.required}, have ${err.available}`);
+  } else if (err instanceof RateLimitError) {
+    console.error(`Rate limited; resets at ${err.resetsAt}`);
+  } else if (err instanceof AuthError) {
+    console.error("Bad app key");
+  } else {
+    throw err;
+  }
+}
+```
+
+| Class | When |
+|---|---|
+| `AuthError` | 401 — missing/invalid app key |
+| `PermissionError` | 403 — app inactive, playground disabled, model/category not allowed |
+| `BadRequestError` | 400 — invalid/unknown model or payload |
+| `InsufficientBalanceError` | 402 — not enough credits (`.required`, `.available`) |
+| `RateLimitError` | 429 — rate/cost cap (`.kind`, `.resetsAt`, `.retryAfterMs`) |
+| `NotFoundError` | 404 — job/workflow not found |
+| `APIError` | 5xx — upstream error |
+| `ConnectionError` | network failure / timeout |
+| `JobFailedError` | async media job failed (`.jobId`) |
+| `JobTimeoutError` | async job exceeded poll timeout (`.jobId`) |
+
+`429` and `5xx` (and pre-response network errors) are retried automatically with exponential backoff + jitter, respecting rate-limit resets. `4xx` are never retried.
+
+## Configuration
+
+```ts
+new Curvet({
+  appKey: "cvt_app_...",
+  baseURL: "https://curvet.ai/api/v1/playground", // override for staging
+  timeout: 60_000,            // per-request, ms
+  maxRetries: 2,
+  defaultPollIntervalMs: 2500, // async job polling
+  defaultPollTimeoutMs: 180_000,
+  fetch: customFetch,          // for Node < 18 / testing
+});
+```
+
+Per-call overrides: every method accepts a final `options` arg (`{ signal, timeout, maxRetries }`; media methods also take `{ pollIntervalMs, pollTimeoutMs, onProgress }`).
+
+## Development
+
+```bash
+npm install
+npm run typecheck
+npm test        # unit tests (mocked HTTP) — no network, no credits
+npm run build   # ESM + CJS + d.ts via tsup
+
+# live contract test (spends a few credits):
+CURVET_TEST_APP_KEY=cvt_app_xxx npm test
+```
+
+## License
+
+MIT