11Type Reference
22==============
33
4- This page documents all TypeDict parameter types used throughout the SDK.
4+ The Runloop Python SDK uses TypeDict objects for configuration parameters to the various API calls. This page documents the TypeDict objects used throughout the SDK.
55
6- Core Request Options
6+ Blueprint Parameters
77--------------------
88
9- These TypeDicts define options for streaming, timeouts, polling, and other request configuration.
10-
11- .. autotypeddict :: runloop_api_client.sdk._types.ExecuteStreamingCallbacks
12-
13- .. autotypeddict :: runloop_api_client.sdk._types.RequestOptions
14-
15- .. autotypeddict :: runloop_api_client.sdk._types.LongRequestOptions
9+ These TypeDicts define parameters for blueprint creation and listing.
1610
17- .. autotypeddict :: runloop_api_client.sdk._types.PollingRequestOptions
11+ .. autotypeddict :: runloop_api_client.sdk._types.SDKBlueprintCreateParams
1812
19- .. autotypeddict :: runloop_api_client.sdk._types.LongPollingRequestOptions
13+ .. autotypeddict :: runloop_api_client.sdk._types.SDKBlueprintListParams
2014
2115Devbox Parameters
2216-----------------
2317
24- These TypeDicts define parameters for devbox creation, execution, file operations, network tunnels, and snapshots .
18+ These TypeDicts define parameters for devbox creation, listing, and operations .
2519
2620Creation Parameters
2721~~~~~~~~~~~~~~~~~~~
@@ -30,18 +24,18 @@ Creation Parameters
3024
3125.. autotypeddict :: runloop_api_client.sdk._types.SDKDevboxCreateFromImageParams
3226
33- Execution Parameters
27+ Listing Parameters
28+ ~~~~~~~~~~~~~~~~~~
29+
30+ .. autotypeddict :: runloop_api_client.sdk._types.SDKDevboxListParams
31+
32+ Command Execution Parameters
3433~~~~~~~~~~~~~~~~~~~~
3534
3635.. autotypeddict :: runloop_api_client.sdk._types.SDKDevboxExecuteParams
3736
3837.. autotypeddict :: runloop_api_client.sdk._types.SDKDevboxExecuteAsyncParams
3938
40- Listing Parameters
41- ~~~~~~~~~~~~~~~~~~
42-
43- .. autotypeddict :: runloop_api_client.sdk._types.SDKDevboxListParams
44-
4539File Operation Parameters
4640~~~~~~~~~~~~~~~~~~~~~~~~~
4741
@@ -61,7 +55,9 @@ Network Tunnel Parameters
6155.. autotypeddict :: runloop_api_client.sdk._types.SDKDevboxRemoveTunnelParams
6256
6357Snapshot Parameters
64- ~~~~~~~~~~~~~~~~~~~
58+ -------------------
59+
60+ These TypeDicts define parameters for snapshot creation, listing, and updating.
6561
6662.. autotypeddict :: runloop_api_client.sdk._types.SDKDevboxSnapshotDiskParams
6763
@@ -71,15 +67,6 @@ Snapshot Parameters
7167
7268.. autotypeddict :: runloop_api_client.sdk._types.SDKDiskSnapshotUpdateParams
7369
74- Blueprint Parameters
75- --------------------
76-
77- These TypeDicts define parameters for blueprint creation and listing.
78-
79- .. autotypeddict :: runloop_api_client.sdk._types.SDKBlueprintCreateParams
80-
81- .. autotypeddict :: runloop_api_client.sdk._types.SDKBlueprintListParams
82-
8370Storage Object Parameters
8471-------------------------
8572
@@ -90,3 +77,16 @@ These TypeDicts define parameters for storage object creation, listing, and down
9077.. autotypeddict :: runloop_api_client.sdk._types.SDKObjectListParams
9178
9279.. autotypeddict :: runloop_api_client.sdk._types.SDKObjectDownloadParams
80+
81+ Core Request Options
82+ --------------------
83+
84+ These TypeDicts define options for timeouts, idempotency, polling, and other low-level request configuration. All other TypeDicts in the SDK extend from one of these core types.
85+
86+ .. autotypeddict :: runloop_api_client.sdk._types.RequestOptions
87+
88+ .. autotypeddict :: runloop_api_client.sdk._types.LongRequestOptions
89+
90+ .. autotypeddict :: runloop_api_client.sdk._types.PollingRequestOptions
91+
92+ .. autotypeddict :: runloop_api_client.sdk._types.LongPollingRequestOptions
0 commit comments