TypeScript

Install and call

Use the Admin client in a server application that manages Riptide resources. For example, an onboarding service can create a publisher and then list the publishers already in its sandbox, as shown below. Supply your control-plane URL, tenant ID and authorized API key on the server; keep the key out of browser code.

npm install @riptide/admin-client

import { AdminAPIError, AdminClient } from "@riptide/admin-client";
const rt = new AdminClient({ baseUrl: "https://app.acme.example", apiKey: process.env.RIPTIDE_API_KEY });

try {
  const pub = await rt.call("createPublisher", { path: { tenant_id }, body: { public_id: "acme-pub", name: "Acme" } });
} catch (err) {
  if (err instanceof AdminAPIError) console.error(err.status, err.code, err.hint, err.requestId);
}

for await (const pub of rt.pages("listPublishers", { path: { tenant_id } })) console.log(pub.public_id);

Every operation id in the contract is a valid first argument, and its path, query, body and result are typed by the operations interface. TypeScript checks field names; missing required path parameters also return a named runtime error. Iterate through list responses with pages(), or gather all items with collect(). These helpers use items and next_cursor and raise CursorLoopError if the server repeats a cursor.