Memulai sesi

Sesi adalah instans agen di dalam sebuah environment (lingkungan). Setiap sesi mereferensikan sebuah agen dan sebuah environment (keduanya dibuat secara terpisah), serta mempertahankan riwayat percakapan di berbagai interaksi. Sesi mengikuti siklus hidup dua langkah: pertama buat sesi, lalu kirim event pengguna untuk memulai pekerjaan. Anda juga dapat menggabungkan kedua langkah tersebut menjadi satu panggilan dengan initial_events.

Membuat sesi

Sesi memerlukan ID agent dan ID environment. Agen adalah sumber daya berversi; meneruskan ID agent sebagai string akan membuat sesi dengan versi agen terbaru.

session = client.beta.sessions.create(
    agent=agent.id,
    environment_id=environment.id,
)

Untuk menyematkan sesi ke versi agen tertentu, teruskan sebuah objek. Ini memungkinkan Anda mengontrol dengan tepat versi mana yang berjalan dan melakukan peluncuran bertahap versi baru secara independen.

pinned_session = client.beta.sessions.create(
    agent={"type": "agent", "id": agent.id, "version": 1},
    environment_id=environment.id,
)

Mengisi sesi dengan event awal

Anda dapat membuat sesi dan memulai pekerjaannya dalam satu panggilan. initial_events adalah array opsional berisi event awal yang dikirim ke sesi saat pembuatan, diproses secara berurutan. Array ini mendukung event user.message dan user.define_outcome, serta menerima maksimum 50 event. Daftar yang tidak kosong akan memulai loop agen dalam panggilan yang sama: sesi dibuat langsung dalam status running, tanpa permintaan lebih lanjut.

Contoh berikut membuat sesi dengan satu user.message di initial_events:

seeded_session = client.beta.sessions.create(
    agent=agent.id,
    environment_id=environment.id,
    initial_events=[
        {
            "type": "user.message",
            "content": [
                {"type": "text", "text": "List the files in the working directory."}
            ],
        },
    ],
)
# initial_events tidak digemakan pada respons create; baca kembali
# dari daftar event milik sesi.
for event in client.beta.sessions.events.list(seeded_session.id):
    if event.type == "user.message":
        for block in event.content:
            if block.type == "text":
                print(f"Seeded event: {block.text}")

Tidak ada tipe event lain yang diterima. Event yang merespons giliran agen (user.tool_confirmation, user.tool_result, dan user.custom_tool_result) tidak diterima karena belum ada giliran agen, dan user.interrupt tidak diterima karena tidak ada giliran yang perlu dihentikan. Berbeda dengan initial_events pada deployment terjadwal, initial_events milik sesi tidak menerima system.message.

Setiap event di initial_events divalidasi dan disimpan sebelum respons pembuatan dikembalikan, sesuai urutan daftar, dengan ID yang ditetapkan server, persis seolah-olah Anda mengirimkannya ke endpoint kirim event segera setelah pembuatan. Aturan konten per event juga sama dengan endpoint tersebut. Daftar kosong setara dengan menghilangkan field tersebut. Validasi bersifat semua-atau-tidak-sama-sekali: jika ada event yang gagal validasi, seluruh permintaan ditolak dan tidak ada sesi yang dibuat.

Permintaan pembuatan ditolak dalam kasus-kasus berikut:

Event user.define_outcome di initial_events diterima dengan kondisi yang sama seperti mengirimkannya ke sesi yang sudah ada; lihat Mendefinisikan outcome.

Menimpa konfigurasi agen untuk sebuah sesi

Anda dapat meneruskan agent dalam tiga bentuk: string ID agen, objek versi tersemat (type: "agent"), atau objek override (penimpaan). Bentuk override mengubah sebagian konfigurasi agen untuk satu sesi. Gunakan bentuk ini untuk mencoba model yang berbeda atau memberikan alat tambahan dalam satu sesi tanpa membuat versi agen baru. Untuk bentuk override, atur type ke agent_with_overrides dan teruskan id agen serta secara opsional version (hilangkan version untuk menggunakan versi terbaru agen). Kemudian sertakan salah satu dari model, system, tools, mcp_servers, atau skills dengan nilai yang harus digunakan sesi.

Setiap field yang dapat ditimpa mengikuti tiga aturan yang sama:

• Hilangkan field: Sesi mewarisi nilai dari versi agen yang direferensikannya.
• Atur field ke null, atau ke array kosong untuk field daftar: Sesi berjalan dengan field tersebut dikosongkan. Aturan ini berlaku sepenuhnya untuk system dan skills. Ada tiga pengecualian:
  • model tidak pernah dapat dikosongkan. Sesi selalu membutuhkan model, sehingga model: null mengembalikan error 400 agent_model_required.
  • Mengosongkan tools mengembalikan error 400 ketika skills efektif sesi tidak kosong, karena skills memerlukan alat read. Selain itu, tools: null dan tools: [] mengosongkan field tersebut.
  • Mengosongkan mcp_servers mengembalikan error 400 ketika tools efektif sesi masih berisi mcp_toolset yang mereferensikan salah satu server agen. Timpa tools dalam permintaan yang sama untuk menghapus entri mcp_toolset tersebut, lalu kosongkan mcp_servers.
• Atur field ke sebuah nilai: Nilai tersebut menggantikan nilai agen secara penuh. Override tidak pernah digabungkan dengan konfigurasi agen, sehingga override tools harus mencantumkan setiap alat yang harus dimiliki sesi. Demikian pula, override model menggantikan objek model agen secara penuh, sehingga effort milik agen tidak ikut terbawa. Untuk menjalankan sesi pada tingkat effort tertentu, atur effort di dalam objek model pada override. Tingkat yang tidak didukung model akan mengembalikan error 400, dan override model tanpa effort berjalan pada tingkat effort default model tersebut.

Override hanya berlaku untuk sesi yang Anda buat. Override tidak memodifikasi sumber daya agen atau membuat versi agen baru, sehingga sesi lain yang mereferensikan agen yang sama tidak terpengaruh.

Dalam respons, objek agent mencerminkan konfigurasi yang digunakan sesi setelah override diterapkan. id dan version-nya tetap mengidentifikasi agen dan versi tempat override diterapkan. Ini memungkinkan Anda menelusuri sesi kembali ke agen dasarnya.

Contoh berikut memulai sesi yang menimpa model dan mengosongkan prompt sistem:

override_session = client.beta.sessions.create(
    agent={
        "type": "agent_with_overrides",
        "id": agent.id,
        "model": {"id": "claude-sonnet-5"},
        "system": None,  # clear the agent's system prompt for this session
    },
    environment_id=environment.id,
)
# Agen pada respons adalah snapshot terselesaikan dengan override yang diterapkan.
print(f"Model: {override_session.agent.model.id}")
print(f"System: {override_session.agent.system}")

Menyematkan geo inferensi untuk sebuah sesi

Karena override model menggantikan objek model agen secara penuh, override tersebut juga mengatur atau mengosongkan pin inference_geo model untuk sesi: override yang menyertakan inference_geo menyematkan geografi yang melayani permintaan model sesi, dan override yang menghilangkannya mengosongkan pin agen sehingga sesi mengikuti default_inference_geo workspace. Nilai yang ditimpa divalidasi terhadap allowed_inference_geos workspace saat sesi dibuat.

Contoh berikut memulai sesi dari agen yang modelnya tidak memiliki pin geo, menyematkan permintaan model sesi ke inferensi US dengan menyertakan inference_geo dalam override model, dan mencetak nilai yang dikembalikan dalam agent.model pada respons:

session = client.beta.sessions.create(
    agent={
        "type": "agent_with_overrides",
        "id": agent.id,
        # Replaces the agent's `model` in full: restate `id`, add `inference_geo` to pin.
        "model": {"id": "claude-opus-5-5", "inference_geo": "us"},
    },
    environment_id=environment.id,
)
print(f"Inference geo: {session.agent.model.inference_geo}")

Menetapkan anggaran sesi

Untuk membatasi berapa banyak yang dapat dibelanjakan sebuah sesi, teruskan objek budget opsional saat Anda membuatnya. Anggaran adalah batas atas yang ketat pada list cost (biaya daftar) sesi: platform menghargai semua yang dikonsumsi sesi dengan tarif daftar publik, dan sesi berhenti mengeluarkan permintaan model baru setelah total berjalan tersebut mencapai max_list_cost. Atur type ke limit dan berikan max_list_cost sebuah amount dan currency. amount adalah bilangan bulat dalam sen AS yang ditulis sebagai string, seperti "2500" untuk $25,00; API menerima string alih-alih angka sehingga tidak ada pembulatan floating-point yang pernah diterapkan. USD adalah satu-satunya mata uang yang saat ini didukung. Ketika sesi mencapai batas, sesi dijeda dan menjadi idle dengan stop reason budget_reached. Batas ini diberlakukan di antara permintaan model, sehingga permintaan yang melewatinya diselesaikan terlebih dahulu dan list cost akhir sesi dapat berakhir sedikit melewati batas. Anggaran hanya dapat dilampirkan saat pembuatan: Anda dapat mengubah atau menghapusnya nanti, tetapi Anda tidak dapat menambahkannya ke sesi yang dibuat tanpa anggaran.

Contoh berikut membuat sesi dengan anggaran $25,00; respons mengembalikan budget pada sumber daya sesi:

curl -fsSL https://api.anthropic.com/v1/sessions \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "anthropic-beta: managed-agents-2026-04-01" \
  -H "content-type: application/json" \
  -d @- <<EOF
{
  "agent": "$AGENT_ID",
  "environment_id": "$ENVIRONMENT_ID",
  "budget": {
    "type": "limit",
    "max_list_cost": {"amount": "2500", "currency": "USD"}
  }
}
EOF

Lihat Anggaran sesi untuk mengetahui cara kerja pemberlakuan, apa yang dihitung ke dalam list cost, dan bagaimana anggaran berperilaku dalam sesi multiagen.

Autentikasi MCP melalui vault

Jika agen Anda menggunakan alat MCP yang memerlukan autentikasi, teruskan vault_ids saat pembuatan sesi untuk mereferensikan vault yang berisi kredensial OAuth tersimpan. Anthropic mengelola refresh token atas nama Anda. Lihat Autentikasi dengan vault untuk mengetahui cara membuat vault dan mendaftarkan kredensial.

vault_session = client.beta.sessions.create(
    agent=agent.id,
    environment_id=environment.id,
    vault_ids=[vault.id],
)

Memulai sesi

Membuat sesi tanpa initial_events akan mendaftarkan sesi tetapi tidak memulai pekerjaan apa pun; sandbox environment mulai diprovisikan segera setelah sesi dibuat, sehingga panggilan alat pertama tidak perlu menunggunya. Untuk mendelegasikan tugas, kirim event ke sesi menggunakan event pengguna. Untuk menyediakan event pertama dalam permintaan pembuatan, lihat Mengisi sesi dengan event awal. Sesi bertindak sebagai state machine yang melacak kemajuan sementara event menggerakkan eksekusi yang sebenarnya.

client.beta.sessions.events.send(
    session.id,
    events=[
        {
            "type": "user.message",
            "content": [
                {"type": "text", "text": "List the files in the working directory."}
            ],
        },
    ],
)

Lihat Aliran event sesi untuk mengetahui cara melakukan streaming respons agen dan menangani konfirmasi alat.

Lihat Status sesi untuk mengetahui status-status yang dilalui sebuah sesi.

Langkah selanjutnya