@runappsai/sdk 0.3.1 → 0.5.0

package/README.md

@@ -1,11 +1,17 @@
-# RunApps SDK for JavaScript / TypeScript
+# RunApps — SDK and platform docs
 
-The client for building apps on [RunApps](https://www.runapps.ai): call any model (Claude, GPT, Gemini, DeepSeek, Qwen, MiniMax, GLM, Grok), generate images, audio and video, keep per-user files, and let the platform handle sign-in and billing. Zero runtime dependencies — native `fetch`, `FormData` and `ReadableStream` (browsers, Node 18+, Deno, Bun).
+[RunApps](https://www.runapps.ai) is a platform for AI web apps. A creator publishes a static frontend; it runs on its own address, `<slug>.runapps.dev`; users sign in with one RunApps account and pay only for the AI they use. This package is the client for building on it: call any model (Claude, GPT, Gemini, DeepSeek, Qwen, MiniMax, GLM, Grok), generate images, audio and video, keep per-user files, and let the platform handle sign-in and billing.
 
-Two ways to use it:
+There are two ways to use it:
 
-- **In an app you publish on RunApps** — a static bundle served at `<slug>.runapps.dev`. Users sign in with their RunApps account and pay for their own usage; you never hold a key. This is what `authProvider: "runapps"` is for.
-- **From your own code** — server, script or CLI — with a personal API key (`rk_…`).
+- **In an app you publish on RunApps.** Users sign in with their RunApps account and pay for their own usage. You never hold a key: create the client without one, `new RunApps()`, and it signs the user in.
+- **From your own code.** A server, script or CLI uses a personal API key (`rk_…`), billed to you.
+
+Both use the base URL `https://www.runapps.ai` and the same OpenAI-compatible API under `/v1`.
+
+**Contents:** [Install](#install) · [Build an app](#build-an-app) · [Publish it](#publish-it) · [From your own code](#from-your-own-code) · [Chat](#chat) · [Files](#files) · [Models](#models) · [Image, audio, video, embeddings](#image-audio-video-embeddings) · [HTTP API](#http-api) · [Errors](#errors) · [Reference](#reference)
+
+---
 
 ## Install
 
@@ -13,27 +19,28 @@ Two ways to use it:
 npm i @runappsai/sdk
 ```
 
-Or as a script tag:
+Or load it with a script tag, which defines the global `RunApps`:
 
 ```html
 <script src="https://cdn.jsdelivr.net/npm/@runappsai/sdk/dist/sdk.umd.js"></script>
 <script>
-  const client = new RunApps({ authProvider: "runapps" });
+  const client = new RunApps();   // no key: users sign in with RunApps
 </script>
 ```
 
-## Building an app
+No runtime dependencies. Runs in browsers, Node 18+, Deno and Bun.
+
+## Build an app
 
 ### 1. Create the app, then develop against it
 
-An app gets its slug the moment you create it on the dashboard (Creator → Publish) — no zip needed yet. Pass that slug as `project` and your dev server runs against the real platform:
+Create the app on the dashboard, under **Creator → Publish**. It gets its slug at once, as a draft visible only to you, before you upload anything. Pass the slug as `project` and run your dev server as usual:
 
 ```ts
 import { RunApps } from "@runappsai/sdk";
 
 const client = new RunApps({
-  authProvider: "runapps",   // sign-in, token, refresh — all handled
-  project: "my-tool",        // the draft's slug; unchanged after you upload
+  project: "my-tool",   // the draft's slug; it stays the same after you upload
 });
 
 const resp = await client.chat.create({
@@ -43,99 +50,91 @@ const resp = await client.chat.create({
 console.log(resp.choices[0].message.content);
 ```
 
-- Sign-in works from `http://localhost:<any port>`; the first call redirects to the RunApps grant page and back.
-- Calls are billed to the signed-in user — while developing, that is you.
-- Files and private prompts already use the app's real namespace, so nothing moves when you upload.
+- Sign-in works from `http://localhost` on any port. The first call sends you to RunApps to sign in and back.
+- Calls are charged to the signed-in user, which is you while developing.
+- Files and private prompts already use the app's real space, so nothing moves when you upload.
 
-When the app is ready, build it, zip it, and upload it to the same app. Set it private (reachable by link) or submit it for review to be listed in the library.
+When the app is ready, build it, zip the output and upload it to the same app. See [Publish it](#publish-it).
 
-### 2. Sign-in details
+### 2. Sign-in
 
 ```ts
-await client.chat.create({ ... });   // redirects to the grant page on first use
+await client.chat.create({ ... });   // sends the user to sign in on first use
 
-client.signIn();                     // force the redirect
-client.signOut();                    // clear the cached token (sticky across reloads)
-client.user;                         // { id, name } | null
-client.auth?.onTokenChange(t => {}); // subscribe to (re)acquisition
+client.signIn();                     // send them now
+client.signOut();                    // forget the token, also across reloads
+client.user;                         // { id, name } or null
+client.auth?.onTokenChange(t => {}); // react to sign-in
 client.auth?.hasFreshToken();        // avoid showing a "sign in" button needlessly
 ```
 
-`showIdentityBadge` (default `true`) draws a small activity badge; `badgePosition` places it.
+The SDK holds one token per user per app. It draws a small activity badge while it works; turn it off with `showIdentityBadge: false`, or move it with `badgePosition`.
 
-`project` is optional on `*.runapps.dev` — the origin already says which app it is. It is required on localhost and when the client runs on a personal key (see below). Sign-in only works on the app's own `*.runapps.dev` address and on `http://localhost`. In Node, `authProvider: "runapps"` is a no-op; use `apiKey`.
+`project` is optional on `*.runapps.dev`, where the address already says which app it is. It is required on localhost and when the client runs on a personal key. Sign-in only works on the app's own `*.runapps.dev` address and on `http://localhost`. With no key, a browser client signs the user in on its own; outside a browser there is no one to sign in, so pass `apiKey`.
 
 ### 3. Private prompts
 
-Anything in your frontend can be read in the browser. Name your prompt files in a `bundle.json` at the root of your zip — `{"prompts": {"outline": "prompts/outline.md"}}` — or put them under `.runapps/prompts/<id>.md`. The platform never serves `bundle.json`, the files it names, or any dot folder; call the prompts by id:
+Everything in a frontend can be read in the browser. To keep a prompt private, ship it in the bundle where the platform reads it but never serves it. Put a `bundle.json` at the root of the zip that names your prompt files:
+
+```json
+{
+  "prompts": {
+    "outline": "prompts/outline.md",
+    "critic": "prompts/critic.md"
+  }
+}
+```
+
+Neither `bundle.json` nor the files it names can be downloaded from your app's address. Files under `.runapps/prompts/<id>.md` also work without an entry, because dot folders are never served. Call a prompt by id and fill its `{{variables}}`:
 
 ```ts
 await client.chat.create({
   model: "Claude Sonnet 4.6",
   messages: [{ role: "user", content: "A detective in a lighthouse." }],
-  prompt: { id: "outline", vars: { genre: "mystery" } },   // {{genre}} in the file
+  prompt: { id: "outline", vars: { genre: "mystery" } },   // {{genre}} in outline.md
 });
 ```
 
-The gateway prepends the prompt as the system message and asks the model to keep it confidential; a reply that repeats 30+ characters of it verbatim is withheld (`finish_reason: "content_filter"`). While developing locally, before a bundle exists, send the text inline as `prompt.template` — accepted only from the app's creator — and keep it out of production builds with `import.meta.env.DEV`.
+The platform adds the prompt as the system message and tells the model to keep it confidential. A reply that repeats 30 or more consecutive characters of it is withheld, with `finish_reason: "content_filter"`.
 
-### 4. Per-user files
+While developing locally, before a bundle exists, send the text inline as `prompt: { template: "…", vars }`. Only the app's creator may do this. Keep it out of production builds, for example behind `import.meta.env.DEV`.
 
-Every app gets a file space per signed-in user, addressed by POSIX-style paths. `FileObject.url` is a stable public address you can drop into `<img src>`.
+## Publish it
 
-```ts
-// Write. body: Blob | File | ArrayBuffer | Uint8Array | ReadableStream | string
-const obj = await client.files.put("assets/logo.png", pngBlob, { contentType: "image/png" });
-await client.files.putString("notes.md", "# hello");
-await client.files.putFromURL("cache/cat.jpg", "https://example.com/cat.jpg"); // gateway fetches it
+Upload your build as a **zip** on the app's publish page:
 
-// Read.
-const blob = await client.files.get("assets/logo.png");
-const meta = await client.files.stat("assets/logo.png");   // size, etag, last_modified, url
-await client.files.exists("assets/logo.png");
+- **Size.** Up to 50 MB.
+- **Entry page.** The zip needs at least one HTML file. `index.html` is the default page, and you can pick another.
+- **Asset paths.** Your app runs at the root of its own address, so absolute paths such as `/assets/app.js` work.
+- **Client-side routing.** A request for a path without a file extension that doesn't exist, such as `/settings`, gets your entry page.
+- **Hidden files.** Files and folders whose name starts with a dot, such as `.env` or `.git`, are never served.
 
-// List, with an optional shell glob (*, **, ?, [abc]) matched against the whole path.
-const page = await client.files.list({ prefix: "assets/", glob: "**/*.png", limit: 100 });
-// page.next_cursor → pass as cursor for the next page
+You can upload a new zip at any time; it replaces the old one immediately.
 
-// Mutate.
-await client.files.move("draft.md", "published.md");
-await client.files.copy("template.md", "instances/today.md");
-await client.files.del("old.log");
-await client.files.deleteMany({ prefix: "tmp/" });
-await client.files.deleteMany({ glob: "**/*.tmp" });
+| Visibility | Who can open it | Listed in the library |
+|---|---|---|
+| Draft | Only you | No |
+| Private | Anyone with the link | No |
+| Public | Everyone | Yes, after review |
 
-// Several ops in one round trip; each result has its own ok/error.
-await client.files.batch([
-  { op: "put_url", path: "a.jpg", src_url: "https://example.com/a.jpg" },
-  { op: "copy", from: "a.jpg", to: "b.jpg" },
-  { op: "del", path: "a.jpg" },
-]);
-```
+Submitting an app as public sends it to review. If it is rejected, fix it and submit again.
 
-**Keeping app state in a file** — read, modify, write, without overwriting another tab's save. Every read carries the file's ETag; `ifMatch` makes the write fail (412) if the file changed since:
+### Earnings
 
-```ts
-const { value, etag } = await client.files.readJSON<{ score: number }>("state.json");
-const next = { ...(value ?? { score: 0 }), score: (value?.score ?? 0) + 1 };
-try {
-  await client.files.put("state.json", JSON.stringify(next), {
-    contentType: "application/json",
-    ...(etag ? { ifMatch: etag } : { ifNoneMatch: true }),   // first save: must not exist
-  });
-} catch (e) {
-  if (e instanceof APIError && e.statusCode === 412) { /* re-read, merge, retry */ }
-}
-```
+Set a **creator fee** of 0% to 50% on the publish page. On every AI call a user makes in your app, they pay the fee on top of the model charge. The whole fee goes to your **earnings balance**, and your own use of your app carries no fee. You can transfer earnings to your main balance or withdraw them to PayPal, with a $10 minimum and 3 to 5 business days for payouts.
 
-`files.read(path)` is `get` plus the ETag for non-JSON files. `ifNoneMatch: true` refuses to overwrite (409).
+### What your users see
+
+Users find public apps in the library and open them at `<slug>.runapps.dev`. They top up a US-dollar balance by card or PayPal, or Alipay and WeChat Pay in the Chinese interface, and each call is charged at the model's price plus your fee. Your app's page shows the fee before they open it. Users can set a daily budget, and the files your app saves for them appear on their Storage page. Removing your app from their account deletes those files.
 
 ## From your own code
 
+Create a key on the dashboard's **API Keys** page.
+
 ```ts
-import { RunApps, APIError } from "@runappsai/sdk";
+import { RunApps } from "@runappsai/sdk";
 
-const client = new RunApps({ apiKey: "rk_…" });   // Dashboard → API Keys
+const client = new RunApps({ apiKey: "rk_…" });
 
 const resp = await client.chat.create({
   model: "Gemini 3 Flash",
@@ -144,23 +143,27 @@ const resp = await client.chat.create({
 console.log(resp.usage.total_cost);   // USD
 ```
 
-The base URL is `https://www.runapps.ai` in both modes; `baseURL` overrides it.
-
-**Files with a personal key** — a personal key has no app of its own, so name the app: `new RunApps({ apiKey, project: "my-tool" })`. You get your own files in that app, the same ones the app sees for you, provided you have added the app or created it.
-
-**Any OpenAI-compatible SDK works too.** Point it at the platform with your `rk_…` key:
+Any OpenAI-compatible client works too:
 
 ```python
 from openai import OpenAI
+
 client = OpenAI(api_key="rk_...", base_url="https://www.runapps.ai/v1")
 client.chat.completions.create(model="Claude Sonnet 4.6", messages=[{"role": "user", "content": "Hello!"}])
 ```
 
-Browse `GET /v1/models` (no auth) for the live catalogue and per-model prices.
+```bash
+curl https://www.runapps.ai/v1/chat/completions \
+  -H "Authorization: Bearer $RUNAPPS_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{"model": "Claude Sonnet 4.6", "messages": [{"role": "user", "content": "Hello!"}]}'
+```
+
+Never put an `rk_…` key in a frontend; an app on RunApps creates its client without a key. `baseURL` overrides the base URL in either mode.
 
 ## Chat
 
-OpenAI-compatible, streaming or not. The final streamed chunk carries `usage`.
+`POST /v1/chat/completions` follows the OpenAI format, streaming or not. If you leave out `model`, the user's default model is used, then the platform's. `usage.total_cost` is the charge in USD; when streaming, the last chunk carries `usage`.
 
 ```ts
 for await (const chunk of client.chat.stream({ model: "Gemini 3 Flash", messages })) {
@@ -169,10 +172,10 @@ for await (const chunk of client.chat.stream({ model: "Gemini 3 Flash", messages
 }
 ```
 
-**Images, video and audio in messages** — check the model first with `acceptsModality(model, "video")`; the gateway rejects unsupported parts with a 400 before billing:
+**Images, video and audio in messages.** Check that the model accepts them with `acceptsModality(model, "video")`; unsupported parts are rejected with a 400 before anything is charged.
 
 ```ts
-import { userMessageParts, textPart, imagePart, videoPart, audioPart } from "@runappsai/sdk";
+import { userMessageParts, textPart, videoPart } from "@runappsai/sdk";
 
 await client.chat.create({
   model: "Gemini 3 Vision",
@@ -180,9 +183,11 @@ await client.chat.create({
 });
 ```
 
-**Your own tools** — pass `tools: [{ type: "function", function: { name, description, parameters } }]`, read `choices[0].message.tool_calls`, answer with `toolResultMessage(toolCallId, output)` on the next turn.
+**Your own tools.** Pass `tools: [{ type: "function", function: { name, description, parameters } }]`, read `choices[0].message.tool_calls`, and answer with `toolResultMessage(toolCallId, output)` on the next turn.
+
+### Server tools
 
-**Server tools** — the platform searches and reads the web for the model, looping until it answers; your code only sees the result. Combine freely with your own `tools`.
+The platform can search and read the web for the model, looping until it answers. Your code only sees the final reply.
 
 ```ts
 import { ServerTools } from "@runappsai/sdk";
@@ -191,14 +196,74 @@ const resp = await client.chat.create({
   model: "Claude Sonnet 4.6",
   messages: [{ role: "user", content: "What is the latest stable Go version?" }],
   server_tools: [ServerTools.WebSearch, ServerTools.WebFetch],
-  max_server_iterations: 5,                 // default 5, max 10
+  max_server_iterations: 5,                 // default 5, at most 10
 });
 for (const t of resp.usage.tool_costs ?? []) console.log(t.name, t.count, t.cost);
 ```
 
-`WebSearch` and `TwitterSearch` are priced per call, `WebFetch` is free; `usage.total_cost` includes tools and tokens. With `stream: true` the tool rounds run silently and the final answer streams.
+| Tool | What it does | Price |
+|---|---|---|
+| `web_search` | Searches the web | Per call |
+| `web_fetch` | Reads a page as text | Free |
+| `twitter_search` | Searches posts on X | Per call |
+
+The tokens of every round and each tool call are billed together, and `usage.total_cost` includes both. Server tools combine with your own `tools`; if the model calls one of yours, the loop stops and the call is returned to you. With `stream: true` the tool rounds run silently and the final answer streams.
+
+## Files
+
+Each app has a file space for each signed-in user. Paths look like POSIX paths, and every file has a public `url` you can use in `<img src>`.
+
+```ts
+// Write. body: Blob | File | ArrayBuffer | Uint8Array | ReadableStream | string
+const obj = await client.files.put("assets/logo.png", pngBlob, { contentType: "image/png" });
+await client.files.putString("notes.md", "# hello");
+await client.files.putFromURL("cache/cat.jpg", "https://example.com/cat.jpg"); // the platform fetches it
+
+// Read.
+const blob = await client.files.get("assets/logo.png");
+const meta = await client.files.stat("assets/logo.png");   // size, etag, last_modified, url
+await client.files.exists("assets/logo.png");
+
+// List, with an optional glob (*, **, ?, [abc]) matched against the whole path.
+const page = await client.files.list({ prefix: "assets/", glob: "**/*.png", limit: 100 });
+// page.next_cursor → pass as cursor for the next page
+
+// Change.
+await client.files.move("draft.md", "published.md");
+await client.files.copy("template.md", "instances/today.md");
+await client.files.del("old.log");
+await client.files.deleteMany({ prefix: "tmp/" });
+
+// Several operations in one round trip; each result has its own ok and error.
+await client.files.batch([
+  { op: "put_url", path: "a.jpg", src_url: "https://example.com/a.jpg" },
+  { op: "copy", from: "a.jpg", to: "b.jpg" },
+  { op: "del", path: "a.jpg" },
+]);
+```
+
+**Saving app state safely.** Every read returns the file's ETag. Writing with `ifMatch` fails with 412 if another tab or device changed the file since you read it, so a save never silently overwrites someone else's:
 
-Message builders: `userMessage`, `systemMessage`, `assistantMessage`, `toolResultMessage`, `userMessageParts`, `textPart`, `imagePart`, `videoPart`, `audioPart`.
+```ts
+import { APIError } from "@runappsai/sdk";
+
+const { value, etag } = await client.files.readJSON<{ score: number }>("state.json");
+const next = { score: (value?.score ?? 0) + 1 };
+try {
+  await client.files.put("state.json", JSON.stringify(next), {
+    contentType: "application/json",
+    ...(etag ? { ifMatch: etag } : { ifNoneMatch: true }),   // first save: must not exist yet
+  });
+} catch (e) {
+  if (e instanceof APIError && e.statusCode === 412) { /* read again, merge, retry */ }
+}
+```
+
+`files.read(path)` is `get` plus the ETag, for files that aren't JSON. `ifNoneMatch: true` refuses to overwrite an existing file (409).
+
+**Files from your own code.** A personal key has no app of its own, so name the app: `new RunApps({ apiKey, project: "my-tool" })`. You get your own files in that app, the same ones the app sees for you. It must be an app you have added or created.
+
+Paths are at most 900 bytes, and a single file is at most 200 MB.
 
 ## Models
 
@@ -207,26 +272,26 @@ const all = await client.models.list();
 const video = await client.models.list({ capability: "video_generation" });
 ```
 
-Prices are in pips per million tokens (1 USD = 1,000,000 pips). Each model carries `capability_tags` (stable ids such as `t2v`, `i2v`, `voice_clone`, `timestamps` — filter with `hasCapabilityTag`), chat models carry `input_modalities` (`acceptsModality`), and every model exposes its input contract through `getOptionsSchema(model)`: accepted fields, bounds, enums, cross-field constraints, and a catalogue of voices or emotions. `validateRequest(schema, body)` returns every problem at once for a form to show.
+`GET /v1/models` needs no key. Token prices are in pips per million tokens, where 1 USD is 1,000,000 pips. Each model carries `capability_tags`, such as `t2v`, `i2v`, `voice_clone` or `timestamps`; filter with `hasCapabilityTag`. Chat models list `input_modalities`; check with `acceptsModality`. Every model describes its accepted options through `getOptionsSchema(model)`: fields, bounds, enums, cross-field rules, and a catalogue of voices or emotions. `validateRequest(schema, body)` returns every problem at once for a form to show. Live prices are also on the [pricing page](https://www.runapps.ai/pricing).
 
 ## Image, audio, video, embeddings
 
 ```ts
-// Image — data: URI (sync) or hosted blob URL (async); decodeMediaUrl() gives bytes.
+// Image: a data: URI (sync) or a hosted URL (async); decodeMediaUrl() gives the bytes.
 const img = await client.image.generate("MiniMax Image-01", {
   prompt: "a developer at a laptop, anime style",
   resolution: "2K", aspect_ratio: "16:9",        // or size: "WxH"
   reference_image_urls: ["https://…"],
 });
 await client.image.edit("GPT Image", { image: { data: bytes, filename: "photo.png" }, prompt: "add a party hat" });
-// generateAsync / submitGenerate + getAsyncStatus for jobs longer than ~100 s
+// generateAsync, or submitGenerate + getAsyncStatus, for jobs longer than about 100 s
 
 // Speech.
 const speech = await client.audio.speech("MiniMax Speech 2.6 HD", { input: "Hello", voice: "English_radiant_girl", emotion: "happy" });
 const text = await client.audio.transcribe("OpenAI/Whisper", { file: { data: audioBytes, filename: "a.mp3" } });
 // speechAsync / transcribeAsync for long jobs; voices and emotions are in getOptionsSchema(model).catalog
 
-// Video — always async.
+// Video: always async.
 const task = await client.video.generate("MiniMax Hailuo 2.3", { prompt: "a gentle ocean wave", duration: 5 });
 const status = await client.video.wait(task.id, { pollIntervalMs: 5000 });
 if (status.status === "succeeded") await client.video.getContent(task.id);
@@ -235,9 +300,66 @@ if (status.status === "succeeded") await client.video.getContent(task.id);
 const e = await client.embeddings.create("text-embedding-3-small", { input: ["alpha", "beta"] });
 ```
 
-`VideoGenerateParams` covers keyframes (`first_frame_url` / `last_frame_url`), reference inputs, source video/image/audio drivers, `service_tier: "flex"`, and more; every `*_url` accepts `https://` or a `data:` URI (`encodeImageUrl(bytes)`).
+`VideoGenerateParams` covers keyframes (`first_frame_url`, `last_frame_url`), reference inputs, source video, image and audio drivers, `service_tier: "flex"`, and more. Every `*_url` accepts `https://` or a `data:` URI (`encodeImageUrl(bytes)`).
+
+## HTTP API
+
+Base URL `https://www.runapps.ai`. Send `Authorization: Bearer <key or app token>`.
+
+| Request | Does |
+|---|---|
+| `POST /v1/chat/completions` | Chat, OpenAI format |
+| `GET /v1/models` | Model catalogue and prices (no key needed) |
+| `POST /v1/images/generations` | Generate images |
+| `POST /v1/images/edits` | Edit an image |
+| `POST /v1/audio/speech` | Text to speech |
+| `POST /v1/audio/transcriptions` | Speech to text |
+| `GET /v1/audio/voices` | Voices for a speech model |
+| `POST /v1/videos/generations` | Start a video job |
+| `GET /v1/videos/generations/<id>` | Job status |
+| `GET /v1/videos/<id>/content` | The finished video |
+| `POST /v1/embeddings` | Embeddings |
+| `/v1/async/…` | Async versions of the image and audio calls: submit, then poll |
+
+### Files over HTTP
+
+With an app token the routes are under `/v1/files`. With a personal key, put the app in the path: `/v1/p/<slug>/files`.
+
+| Request | Does |
+|---|---|
+| `GET /v1/files?prefix=&glob=&limit=&cursor=` | List files. `limit` defaults to 100, at most 1000. |
+| `GET /v1/files/<path>` | Read a file. Returns `ETag`; sends 304 for a matching `If-None-Match`. |
+| `HEAD /v1/files/<path>` | Metadata only. |
+| `PUT /v1/files/<path>` | Write the request body. Honours `Content-Type`, `If-Match: <etag>` and `If-None-Match: *`. |
+| `DELETE /v1/files/<path>` | Delete a file. |
+| `POST /v1/files/move` | `{"from", "to"}` |
+| `POST /v1/files/copy` | `{"from", "to"}` |
+| `POST /v1/files/delete` | `{"prefix"}` or `{"glob"}` deletes many. |
+| `POST /v1/files/put-url` | `{"path", "src_url"}`: the platform downloads the URL into the file. |
+| `POST /v1/files/batch` | `{"ops": [...]}`: up to 64 operations, `put_url`, `del`, `move`, `copy`, `exists`, `stat`. |
+
+A file object has `path`, `size`, `content_type`, `etag`, `last_modified` and `url`.
+
+### Sign-in without the SDK
+
+Send the user to:
+
+```
+https://www.runapps.ai/api/sdk/grant?origin=<your origin>&redirect_to=<url to return to>&token_name=runapps_token[&project_id=<slug>]
+```
+
+The origin must be your app's own `https://<slug>.runapps.dev` or `http://localhost` on any port, and `redirect_to` must be on that origin. After signing in, the user comes back to `redirect_to` with `#runapps_token=<token>` in the URL fragment. Send it as `Authorization: Bearer <token>` on `/v1` calls. The token belongs to that user in that app. On localhost, pass your app's slug as `project_id`.
+
+## Errors
 
-## Errors and cancellation
+| Status | Meaning |
+|---|---|
+| 400 | Bad request, such as an input the model doesn't accept. Nothing is charged. |
+| 401 | Missing or invalid key or token. In browser sign-in mode the SDK refreshes the token and retries once. |
+| 402 | The balance is too low, or today's budget is reached. |
+| 409 | `If-None-Match: *` and the file already exists. |
+| 412 | `If-Match` and the file changed since you read it. |
+| 429 | Too many requests at once. Retry shortly. |
 
 ```ts
 try {
@@ -248,9 +370,9 @@ try {
 }
 ```
 
-Every call takes `{ signal }`. In browser-auth mode a 401 is retried once after refreshing the token.
+Every call takes `{ signal }` for cancellation.
 
-## API reference
+## Reference
 
 | Service | Methods |
 |---|---|
@@ -262,13 +384,21 @@ Every call takes `{ signal }`. In browser-auth mode a 401 is retried once after
 | `client.video` | `generate`, `getStatus`, `wait`, `getContent` |
 | `client.embeddings` | `create` |
 
-Browser auth: `client.signIn()`, `client.signOut()`, `client.user`, `client.auth`.
+Browser sign-in: `client.signIn()`, `client.signOut()`, `client.user`, `client.auth`.
 
-Helpers: `hasCapabilityTag`, `acceptsModality`, `getOptionsSchema`, `acceptsField`, `requiresField`, `allowedValuesFor`, `validateRequest`, `supportsVoiceClone`, `supportsInstructText`, `defaultVoice`, `encodeImageUrl`, `decodeMediaUrl`, the message builders, `ServerTools`.
+Helpers: `hasCapabilityTag`, `acceptsModality`, `getOptionsSchema`, `acceptsField`, `requiresField`, `allowedValuesFor`, `validateRequest`, `supportsVoiceClone`, `supportsInstructText`, `defaultVoice`, `encodeImageUrl`, `decodeMediaUrl`, `ServerTools`, and the message builders `userMessage`, `systemMessage`, `assistantMessage`, `toolResultMessage`, `userMessageParts`, `textPart`, `imagePart`, `videoPart`, `audioPart`.
+
+### Addresses
+
+| Address | What it serves |
+|---|---|
+| `www.runapps.ai` | The website, dashboard, sign-in and the API (`/v1`) |
+| `<slug>.runapps.dev` | Each app |
+| `files.runapps.ai` | Public file links |
 
-## Compatibility
+### Upgrading from `@runjobsai/sdk`
 
-Browsers (any modern), Node 18+, Deno, Bun. Never ship an `rk_…` key to a browser — an app published on RunApps uses `authProvider: "runapps"` instead, and the user pays for their own usage.
+The package was renamed. Install `@runappsai/sdk` and change your imports; the API is the same. Users signed in with 0.2.1 or later stay signed in after the upgrade. `authProvider` no longer needs to be set: a browser client without a key signs the user in. `RunJobs` still works as a deprecated alias of `RunApps`, and so does `authProvider: "runjobs"`.
 
 ## License
 

package/dist/activity-tracker.js

@@ -82,7 +82,7 @@ export class ActivityTracker {
             }
             catch (err) {
                 // eslint-disable-next-line no-console
-                console.error("[runjobs sdk] ActivityTracker onChange listener threw:", err);
+                console.error("[runapps sdk] ActivityTracker onChange listener threw:", err);
             }
         }
     }

package/dist/browser-auth.d.ts

@@ -165,7 +165,8 @@ export declare class BrowserAuth {
     private markSignedOut;
     private clearSignedOut;
     private removeBadge;
-    /** Parse the #runjobs_token=… fragment, install, then strip it. */
+    /** Parse the #runapps_token=… fragment (or the older #runjobs_token=…),
+     *  install, then strip it. */
     private consumeFragment;
     /** postMessage handshake with the dashboard parent (iframe path). */
     private requestTokenFromParent;

package/dist/browser-auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser-auth.d.ts","sourceRoot":"","sources":["../src/browser-auth.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,0DAA0D;AAC1D,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG,aAAa,GAAG,WAAW,GAAG,UAAU,CAAC;AAEtF,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AA8CD;;;;;;;;;;;GAWG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C;2EACuE;IACvE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,SAAS,CAAsC;IACvD,OAAO,CAAC,eAAe,CAA8B;IACrD,OAAO,CAAC,SAAS,CAAS;gBAEd,IAAI,GAAE,kBAAuB;IA+CzC,iEAAiE;IACjE,QAAQ,QAAa,OAAO,CAAC,MAAM,CAAC,CA0DlC;IAEF,sEAAsE;IACtE,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,IAAI;IAQ3D,6CAA6C;IAC7C,IAAI,IAAI,IAAI,WAAW,GAAG,IAAI,CAE7B;IAED;;;;;;;;;;;OAWG;IACH,aAAa,IAAI,OAAO;IAIxB;;;;;;;;;OASG;IACH,OAAO,IAAI,IAAI;IAWf;;;;;;OAMG;IACH,UAAU,IAAI,IAAI;IASlB,0CAA0C;IAC1C,MAAM,IAAI,IAAI;IAmBd;;;;;;;OAOG;IACH,qBAAqB,CAAC,IAAI,EAAE;QAC1B,UAAU,EAAE,MAAM,CAAC;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC;KAC1B,GAAG,MAAM;IAIV;;;;;;OAMG;IACH,mBAAmB,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE;IAO1D,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,QAAQ;IAQhB,OAAO,CAAC,QAAQ;IAiBhB,OAAO,CAAC,aAAa;IAerB,OAAO,CAAC,aAAa;IAyBrB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,WAAW;IAKnB,mEAAmE;IACnE,OAAO,CAAC,eAAe;IAkCvB,qEAAqE;IACrE,OAAO,CAAC,sBAAsB;IAoD9B;;;;uEAImE;IACnE,OAAO,CAAC,WAAW;CAqCpB"}
+{"version":3,"file":"browser-auth.d.ts","sourceRoot":"","sources":["../src/browser-auth.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,0DAA0D;AAC1D,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG,aAAa,GAAG,WAAW,GAAG,UAAU,CAAC;AAEtF,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AA0DD;;;;;;;;;;;GAWG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C;2EACuE;IACvE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,SAAS,CAAsC;IACvD,OAAO,CAAC,eAAe,CAA8B;IACrD,OAAO,CAAC,SAAS,CAAS;gBAEd,IAAI,GAAE,kBAAuB;IA+CzC,iEAAiE;IACjE,QAAQ,QAAa,OAAO,CAAC,MAAM,CAAC,CA0DlC;IAEF,sEAAsE;IACtE,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,IAAI;IAQ3D,6CAA6C;IAC7C,IAAI,IAAI,IAAI,WAAW,GAAG,IAAI,CAE7B;IAED;;;;;;;;;;;OAWG;IACH,aAAa,IAAI,OAAO;IAIxB;;;;;;;;;OASG;IACH,OAAO,IAAI,IAAI;IAWf;;;;;;OAMG;IACH,UAAU,IAAI,IAAI;IASlB,0CAA0C;IAC1C,MAAM,IAAI,IAAI;IAmBd;;;;;;;OAOG;IACH,qBAAqB,CAAC,IAAI,EAAE;QAC1B,UAAU,EAAE,MAAM,CAAC;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC;KAC1B,GAAG,MAAM;IAIV;;;;;;OAMG;IACH,mBAAmB,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE;IAO1D,OAAO,CAAC,aAAa;IAoBrB,OAAO,CAAC,MAAM;IAId,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,QAAQ;IAQhB,OAAO,CAAC,QAAQ;IAiBhB,OAAO,CAAC,aAAa;IAerB,OAAO,CAAC,aAAa;IA+BrB,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,WAAW;IAKnB;kCAC8B;IAC9B,OAAO,CAAC,eAAe;IAmCvB,qEAAqE;IACrE,OAAO,CAAC,sBAAsB;IAqD9B;;;;uEAImE;IACnE,OAAO,CAAC,WAAW;CAqCpB"}