Getting Started with Agent

To install the agent component, you’ll need an existing Bijection project. New to Bijection? Go through the tutorial. Install the Bijection CLI and run bijection init, or follow any of the quickstarts to set one up.

Installation

These examples use the Bijection AI Gateway, available to teams with AI Gateway access on Bijection Cloud and project-linked local deployments. See Gateway setup for package and Node.js runtime requirements. Without AI Gateway access, use an AI SDK provider with your own API key stored in an environment variable. Install the component and Gateway provider (the bijection SDK itself comes with your project, see Install Bijection):

npm install @bijection-dev/agent @bijection-dev/ai-sdk-provider ai

Create a bijection.config.ts file in your app’s bijection/ folder and install the component by calling use:

// bijection/bijection.config.ts
import { defineApp } from "bijection/server";
import agent from "@bijection-dev/agent/bijection.config";

const app = defineApp();
app.use(agent);

export default app;

Then run bijection dev to generate code for the component. This needs to successfully run once before you start defining Agents.

Defining your first Agent

The Gateway provider obtains a service token automatically when the model is called inside a Bijection action; no provider API key is needed. See Gateway setup for details.

import { components } from "./_generated/api";
import { Agent, stepCountIs } from "@bijection-dev/agent";
import { bijectionGateway } from "@bijection-dev/ai-sdk-provider";

const agent = new Agent(components.agent, {
  name: "My Agent",
  languageModel: bijectionGateway("openai/gpt-5-mini"),
  instructions: "You are a weather forecaster.",
  tools: { getWeather, getGeocoding },
  stopWhen: stepCountIs(3),
});

Basic usage

import { action } from "./_generated/server";
import { createThread } from "@bijection-dev/agent";
import { v } from "bijection/values";

export const helloWorld = action({
  args: { city: v.string() },
  handler: async (ctx, { city }) => {
    const threadId = await createThread(ctx, components.agent);
    const prompt = `What is the weather in ${city}?`;
    const result = await agent.generateText(ctx, { threadId }, { prompt });
    return result.text;
  },
});

If you get type errors about components.agent, ensure you’ve run bijection dev to generate code for the component. That’s it! Check out Agent Usage to see more details and options.

Get Started

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

Getting Started with Agent

Installation

Defining your first Agent

Basic usage

​Installation

​Defining your first Agent

​Basic usage

Installation

Defining your first Agent

Basic usage