Skip to content

Commit 1ea48c5

Browse files
committed
docs: clarify snapshot ID description in JS and Python SDKs
1 parent 0b73eba commit 1ea48c5

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

packages/js-sdk/src/sandbox/sandboxApi.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,8 @@ export interface SnapshotListOpts extends SandboxApiOpts {
232232
*/
233233
export interface SnapshotInfo {
234234
/**
235-
* Unique identifier for the snapshot.
236-
* Can be used as templateId in Sandbox.create() to create a new sandbox from this snapshot.
235+
* Snapshot identifier — template ID with tag, or namespaced name with tag (e.g. my-snapshot:latest).
236+
* Can be used with Sandbox.create() to create a new sandbox from this snapshot.
237237
*/
238238
snapshotId: string
239239
}
@@ -576,7 +576,7 @@ export class SandboxApi {
576576
* @param sandboxId sandbox ID to create snapshot from.
577577
* @param opts snapshot options.
578578
*
579-
* @returns snapshot information including the snapshot ID that can be used with Sandbox.create().
579+
* @returns snapshot information including the snapshot name that can be used with Sandbox.create().
580580
*/
581581
static async createSnapshot(
582582
sandboxId: string,

packages/python-sdk/e2b/sandbox/sandbox_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ class SnapshotInfo:
187187
"""Information about a snapshot."""
188188

189189
snapshot_id: str
190-
"""Unique identifier for the snapshot. Can be used as template ID in Sandbox.create() to create a new sandbox from this snapshot."""
190+
"""Snapshot identifier — template ID with tag, or namespaced name with tag (e.g. my-snapshot:latest). Can be used with Sandbox.create() to create a new sandbox from this snapshot."""
191191

192192

193193
class SnapshotPaginatorBase:

0 commit comments

Comments
 (0)