Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/tame-needles-fry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@e2b/python-sdk': patch
'e2b': patch
---

Add filtering by metadata
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -292,4 +292,6 @@ cython_debug/
# SDK reference artifacts
sdk_ref/
sdkRefRoutes.json
spec/openapi_generated.yml

# SDK Client generated spec
spec/openapi_generated.yml
24 changes: 14 additions & 10 deletions apps/web/src/app/(docs)/docs/sandbox/list/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,6 @@ Running sandbox template id: 3e4rngfa34txe0gxc1zf


## Filtering sandboxes
<Note>
This feature is in a private beta.
</Note>

You can filter sandboxes by specifying <Link href="/docs/sandbox/metadata">Metadata</Link> key value pairs.
Specifying multiple key value pairs will return sandboxes that match all of them.
Expand All @@ -87,7 +84,9 @@ const sandbox = await Sandbox.create({

// List running sandboxes that has `userId` key with value `123` and `env` key with value `dev`.
const runningSandboxes = await Sandbox.list({
filters: { userId: '123', env: 'dev' } // $HighlightLine
query: {
metadata: { userId: '123', env: 'dev' }, // $HighlightLine
},
})
```
```python
Expand All @@ -96,15 +95,20 @@ from e2b_code_interpreter import Sandbox
# Create sandbox with metadata.
sandbox = Sandbox(
metadata={
"env": "dev", # $HighlightLine
"app": "my-app", # $HighlightLine
"user_id": "123", # $HighlightLine
"env": "dev", # $HighlightLine
"app": "my-app", # $HighlightLine
"user_id": "123", # $HighlightLine
},
)

# List running sandboxes that has `userId` key with value `123` and `env` key with value `dev`.
running_sandboxes = Sandbox.list(filters={
"userId": "123", "env": "dev" # $HighlightLine
})
running_sandboxes = Sandbox.list(
query=SandboxQuery(
metadata={
"userId": "123", # $HighlightLine
"env": "dev", # $HighlightLine
}
),
)
```
</CodeGroup>
Loading
Loading