Creating Your First Agent

import { openai } from '@ai-sdk/openai';
import { agent, execute } from '@deepagents/agent';

const assistant = agent({
  name: 'assistant',
  model: openai('gpt-4o'),
  prompt: 'You are a helpful assistant.',
});

const stream = await execute(assistant, 'What is TypeScript?', {});
const text = await stream.text;

console.log(text);

import { execute } from '@deepagents/agent';

const stream = await execute(assistant, 'Tell me a story', {});

// Stream text chunks
for await (const chunk of stream.textStream) {
  process.stdout.write(chunk);
}

// Or get the full text
const text = await stream.text;

import { generate } from '@deepagents/agent';

const result = await generate(assistant, 'What is 2+2?', {});
console.log(result.text);

import { swarm } from '@deepagents/agent';

const stream = swarm(coordinator, 'Complete this task', {});

for await (const chunk of stream) {
  if (chunk.type === 'text-delta') {
    process.stdout.write(chunk.delta);
  }
}

interface UserContext {
  userId: string;
  userName: string;
  preferences: Record<string, string>;
}

const personalizedAgent = agent<unknown, UserContext>({
  name: 'personal_assistant',
  model: openai('gpt-4o'),
  prompt: (ctx) => `
    You are a helpful assistant for ${ctx?.userName || 'the user'}.
    User preferences: ${JSON.stringify(ctx?.preferences || {})}
  `,
});

const context: UserContext = {
  userId: 'user123',
  userName: 'Alice',
  preferences: { theme: 'dark', language: 'en' },
};

const stream = await execute(personalizedAgent, 'Hello!', context);

import { agent, instructions } from '@deepagents/agent';

const analyst = agent({
  name: 'data_analyst',
  model: openai('gpt-4o'),
  prompt: instructions({
    purpose: [
      'You are a data analyst specializing in financial data.',
      'Analyze datasets and provide actionable insights.',
    ],
    routine: [
      'Examine the data for patterns and anomalies',
      'Calculate relevant statistics',
      'Provide clear recommendations',
    ],
  }),
});

# Agent Context
You are a data analyst specializing in financial data.
Analyze datasets and provide actionable insights.


Use the following routine to fulfill the task.
# Routine
1. Examine the data for patterns and anomalies
2. Calculate relevant statistics
3. Provide clear recommendations

const stream = await execute(assistant, 'What is AI?', {});

import { user } from '@deepagents/agent';

const messages = [
  user('What is TypeScript?'),
];

const stream = await execute(assistant, messages, {});

const messages = [
  user('What is TypeScript?'),
  // Previous assistant response would be here
  user('Can you give me an example?'),
];

const stream = await execute(assistant, messages, {});

try {
  const stream = await execute(assistant, 'Hello!', {});
  const text = await stream.text;
  console.log(text);
} catch (error) {
  if (error.name === 'AbortError') {
    console.log('Request was aborted');
  } else {
    console.error('Error:', error.message);
  }
}

const controller = new AbortController();

const stream = await execute(assistant, 'Write a long story', {}, {
  abortSignal: controller.signal,
});

// Cancel after 5 seconds
setTimeout(() => controller.abort(), 5000);

try {
  const text = await stream.text;
} catch (error) {
  if (error.name === 'AbortError') {
    console.log('Execution aborted');
  }
}