Skip to content
Upgrade to 0.3.0

Upgrade to 0.3.0

Replace the Rebyte client fork with the official OpenAI client and update AppKit.

On this pageReplace the API clientUpgrade AppKit togetherMove Workflow and Schedule calls

Rebyte Toolkit 0.3.0 removes the OpenAI API client fork. Standard Agents API requests use the official openai package. AppKit, the CLI and Rebyte-specific extensions are published separately under @rebyteai.

Replace the API client

Terminal
pnpm remove @rebyteai/agent-sdk
pnpm add openai@7.15.0

Replace the old default Rebyte import with OpenAI and configure the endpoint and key explicitly:

ts
import OpenAI from 'openai';

const apiKey = process.env.REBYTE_API_KEY;
if (!apiKey) throw new Error('Set REBYTE_API_KEY');
const client = new OpenAI({
  apiKey,
  baseURL: 'https://api.rebyte.ai/v1',
  maxRetries: 0,
});

The official client defaults to OpenAI's endpoint and does not read REBYTE_* environment variables automatically. Keep organization keys on your application server. maxRetries: 0 prevents automatic retries of requests that could start duplicate work after an ambiguous transport failure.

Existing client.beta.agents calls and saved Agent and Session IDs remain valid. This package upgrade does not reset Sessions or change server-side execution. Use { type: 'openai_hosted' } in place of rebyteSandbox() for a standard hosted environment; at the Rebyte endpoint this protocol value selects Rebyte compute. Import protocol types from openai/resources/... and Stream from openai/core/streaming.

Upgrade AppKit together

Install the packages your application uses at the same release:

Terminal
pnpm add @rebyteai/agent-react@0.3.0 @rebyteai/agent-ui@0.3.0 @rebyteai/agent-server@0.3.0
pnpm add -D @rebyteai/cli@0.3.0

The Node and Cloudflare templates use the official client through the shared server adapter. The browser receives native Agents API Session events. React hooks maintain presentation state and the UI renders it; Rebyte runs the Agent Loop.

The separate @openai/agents package runs an Agent Loop in your application. Installing it is not required for AppKit's hosted Session integration. AppKit 0.3.0 does not implement the ChatKit or Vercel UI message protocols.

Move Workflow and Schedule calls

These are Rebyte-specific resources, available through HTTP or an optional extension composed with the official client:

Terminal
pnpm add @rebyteai/agent-extensions@0.3.0
ts
import { RebyteExtensions } from '@rebyteai/agent-extensions';

const rebyte = new RebyteExtensions(client);
const workflows = await rebyte.workflowAgents.list();
const schedules = await rebyte.schedules.list();

Move old client.workflowAgents and client.schedules calls onto rebyte. Standard client.beta.agents calls stay on the official client. The extension reuses that client's authentication and transport without modifying it. See Workflow Agents and Schedules.

Rebyte fields such as GitHub Skills and Dynamic Workflow are outside some official TypeScript unions. Use the official client's HTTP methods with explicit types for those fields, as shown in hosted environments and Dynamic Workflow. Do not replace or globally widen upstream declarations.

Existing 0.2.x npm artifacts remain available. New integrations should follow Quickstart with the official client.