API de session TypeScript SDK V2 (supprimée)

L’API de session V2 n’est plus supportée. TypeScript Agent SDK 0.3.142 supprime unstable_v2_createSession, unstable_v2_resumeSession, unstable_v2_prompt, et les types SDKSession et SDKSessionOptions.Pour migrer, utilisez l’API query() et les options de session qu’elle accepte. Passez un AsyncIterable<SDKUserMessage> pour les conversations multi-tours, ou options.resume pour continuer une session sauvegardée. Cette page est conservée à titre de référence si vous maintenez du code sur Agent SDK 0.2.x ou antérieur.

V2 était une API de session expérimentale qui supprimait le besoin de générateurs asynchrones et de coordination de rendement. Au lieu de gérer l’état du générateur entre les tours, chaque tour était un cycle send()/stream() séparé. La surface de l’API se réduisait à trois concepts :

createSession() / resumeSession() : Démarrer ou continuer une conversation
session.send() : Envoyer un message
session.stream() : Obtenir la réponse

Installation

Agent SDK 0.2.x est la dernière version qui inclut l’interface V2. La version du package a sauté de 0.2.x directement à 0.3.142, donc la version de suppression ci-dessus et l’épingle d’installation ci-dessous décrivent la même limite. Pour installer la dernière version compatible avec V2, épinglez la version majeure et mineure :

npm install @anthropic-ai/claude-agent-sdk@0.2

Le SDK regroupe un binaire Claude Code natif pour votre plateforme en tant que dépendance optionnelle, vous n’avez donc pas besoin d’installer Claude Code séparément.

Démarrage rapide

Invite unique

Pour les requêtes simples à un seul tour où vous n’avez pas besoin de maintenir une session, utilisez unstable_v2_prompt(). Cet exemple envoie une question mathématique et enregistre la réponse :

import { unstable_v2_prompt } from "@anthropic-ai/claude-agent-sdk";

const result = await unstable_v2_prompt("What is 2 + 2?", {
  model: "claude-opus-4-7"
});
if (result.subtype === "success") {
  console.log(result.result);
}

Session de base

Pour les interactions au-delà d’une seule invite, créez une session. V2 sépare l’envoi et la diffusion en étapes distinctes :

send() envoie votre message
stream() diffuse la réponse

Cette séparation explicite facilite l’ajout de logique entre les tours (comme le traitement des réponses avant d’envoyer des suites). L’exemple ci-dessous crée une session, envoie « Hello ! » à Claude et imprime la réponse textuelle. Il utilise await using (TypeScript 5.2+) pour fermer automatiquement la session lorsque le bloc se termine. Vous pouvez également appeler session.close() manuellement.

import { unstable_v2_createSession } from "@anthropic-ai/claude-agent-sdk";

await using session = unstable_v2_createSession({
  model: "claude-opus-4-7"
});

await session.send("Hello!");
for await (const msg of session.stream()) {
  // Filter for assistant messages to get human-readable output
  if (msg.type === "assistant") {
    const text = msg.message.content
      .filter((block) => block.type === "text")
      .map((block) => block.text)
      .join("");
    console.log(text);
  }
}

Conversation multi-tours

Les sessions persistent le contexte à travers plusieurs échanges. Pour continuer une conversation, appelez send() à nouveau sur la même session. Claude se souvient des tours précédents. Cet exemple pose une question mathématique, puis pose une suite qui fait référence à la réponse précédente :

import { unstable_v2_createSession } from "@anthropic-ai/claude-agent-sdk";

await using session = unstable_v2_createSession({
  model: "claude-opus-4-7"
});

// Turn 1
await session.send("What is 5 + 3?");
for await (const msg of session.stream()) {
  // Filter for assistant messages to get human-readable output
  if (msg.type === "assistant") {
    const text = msg.message.content
      .filter((block) => block.type === "text")
      .map((block) => block.text)
      .join("");
    console.log(text);
  }
}

// Turn 2
await session.send("Multiply that by 2");
for await (const msg of session.stream()) {
  if (msg.type === "assistant") {
    const text = msg.message.content
      .filter((block) => block.type === "text")
      .map((block) => block.text)
      .join("");
    console.log(text);
  }
}

Reprise de session

Si vous avez un ID de session d’une interaction précédente, vous pouvez le reprendre plus tard. Ceci est utile pour les flux de travail de longue durée ou lorsque vous devez persister les conversations entre les redémarrages d’application. Cet exemple crée une session, stocke son ID, la ferme, puis reprend la conversation :

import {
  unstable_v2_createSession,
  unstable_v2_resumeSession,
  type SDKMessage
} from "@anthropic-ai/claude-agent-sdk";

// Helper to extract text from assistant messages
function getAssistantText(msg: SDKMessage): string | null {
  if (msg.type !== "assistant") return null;
  return msg.message.content
    .filter((block) => block.type === "text")
    .map((block) => block.text)
    .join("");
}

// Create initial session and have a conversation
const session = unstable_v2_createSession({
  model: "claude-opus-4-7"
});

await session.send("Remember this number: 42");

// Get the session ID from any received message
let sessionId: string | undefined;
for await (const msg of session.stream()) {
  sessionId = msg.session_id;
  const text = getAssistantText(msg);
  if (text) console.log("Initial response:", text);
}

console.log("Session ID:", sessionId);
session.close();

// Later: resume the session using the stored ID
await using resumedSession = unstable_v2_resumeSession(sessionId!, {
  model: "claude-opus-4-7"
});

await resumedSession.send("What number did I ask you to remember?");
for await (const msg of resumedSession.stream()) {
  const text = getAssistantText(msg);
  if (text) console.log("Resumed response:", text);
}

Nettoyage

Les sessions peuvent être fermées manuellement ou automatiquement en utilisant await using, une fonctionnalité TypeScript 5.2+ pour le nettoyage automatique des ressources. Si vous utilisez une version TypeScript plus ancienne ou rencontrez des problèmes de compatibilité, utilisez plutôt le nettoyage manuel. Nettoyage automatique (TypeScript 5.2+) :

import { unstable_v2_createSession } from "@anthropic-ai/claude-agent-sdk";

await using session = unstable_v2_createSession({
  model: "claude-opus-4-7"
});
// Session closes automatically when the block exits

Nettoyage manuel :

import { unstable_v2_createSession } from "@anthropic-ai/claude-agent-sdk";

const session = unstable_v2_createSession({
  model: "claude-opus-4-7"
});
// ... use the session ...
session.close();

Référence API

`unstable_v2_createSession()`

Crée une nouvelle session pour les conversations multi-tours.

function unstable_v2_createSession(options: {
  model: string;
  // Additional options supported
}): SDKSession;

`unstable_v2_resumeSession()`

Reprend une session existante par ID.

function unstable_v2_resumeSession(
  sessionId: string,
  options: {
    model: string;
    // Additional options supported
  }
): SDKSession;

`unstable_v2_prompt()`

Fonction de commodité unique pour les requêtes à un seul tour.

function unstable_v2_prompt(
  prompt: string,
  options: {
    model: string;
    // Additional options supported
  }
): Promise<SDKResultMessage>;

Interface SDKSession

interface SDKSession {
  readonly sessionId: string;
  send(message: string | SDKUserMessage): Promise<void>;
  stream(): AsyncGenerator<SDKMessage, void>;
  close(): void;
}

Disponibilité des fonctionnalités

L’API de session V2 ne supporte pas toutes les fonctionnalités V1. Les éléments suivants nécessitent l’utilisation du SDK V1 :

Forking de session (option forkSession)
Certains modèles de flux d’entrée avancés

Voir aussi

Référence SDK TypeScript (V1) - Documentation complète du SDK V1
Aperçu SDK - Concepts généraux du SDK
Exemples V2 sur GitHub - Exemples de code fonctionnels

Agent SDK

Concepts fondamentaux

Entrée et sortie

Étendre avec des outils

Personnaliser le comportement

Contrôle et observabilité

Déploiement

Références SDK

API de session TypeScript SDK V2 (supprimée)

Installation

Démarrage rapide

Invite unique

Session de base

Conversation multi-tours

Reprise de session

Nettoyage

Référence API

`unstable_v2_createSession()`

`unstable_v2_resumeSession()`

`unstable_v2_prompt()`

Interface SDKSession

Disponibilité des fonctionnalités

Voir aussi

​Installation

​Démarrage rapide

​Invite unique

​Session de base

​Conversation multi-tours

​Reprise de session

​Nettoyage

​Référence API

​unstable_v2_createSession()

​unstable_v2_resumeSession()

​unstable_v2_prompt()

​Interface SDKSession

​Disponibilité des fonctionnalités

​Voir aussi

Installation

Démarrage rapide

Invite unique

Session de base

Conversation multi-tours

Reprise de session

Nettoyage

Référence API

`unstable_v2_createSession()`

`unstable_v2_resumeSession()`

`unstable_v2_prompt()`

Interface SDKSession

Disponibilité des fonctionnalités

Voir aussi