modal 1.1.5.dev66__py3-none-any.whl → 1.3.1.dev8__py3-none-any.whl

modal_proto/api.proto

@@ -4,7 +4,7 @@ option go_package = "github.com/modal-labs/modal/go/proto";
 
 package modal.client;
 
-import "modal_proto/options.proto";
+import "google/protobuf/any.proto";
 import "google/protobuf/empty.proto";
 import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
@@ -298,10 +298,11 @@ message AppClientDisconnectRequest {
 }
 
 message AppCreateRequest {
-  string client_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string client_id = 1;
   string description = 2;    // Human readable label for the app
   string environment_name = 5;
   AppState app_state = 6;
+  map<string, string> tags = 7;  // Additional metadata to attach to the App
 }
 
 message AppCreateResponse {
@@ -311,7 +312,7 @@ message AppCreateResponse {
 }
 
 message AppDeployRequest {
-  string app_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string app_id = 1;
   reserved 2; // namespace
   string name = 3;
   string object_entity = 4;
@@ -367,6 +368,7 @@ message AppGetLogsRequest {
   float timeout = 2;
   string last_entry_id = 4;
   string function_id = 5;
+  string parametrized_function_id = 11;
   string input_id = 6;
   string task_id = 7;
   string function_call_id = 9;
@@ -399,6 +401,14 @@ message AppGetOrCreateResponse {
   string app_id = 1;
 }
 
+message AppGetTagsRequest {
+  string app_id = 1;
+}
+
+message AppGetTagsResponse {
+  map<string, string> tags = 1;
+}
+
 message AppHeartbeatRequest {
   string app_id = 1;
 }
@@ -436,7 +446,7 @@ message AppLookupResponse {
 }
 
 message AppPublishRequest {
-  string app_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string app_id = 1;
   string name = 2;
   string deployment_tag = 3;  // Additional metadata to identify a deployment
   AppState app_state = 4;  // Published app will be in this state
@@ -468,8 +478,14 @@ message AppSetObjectsRequest {
   reserved 6;
 }
 
+message AppSetTagsRequest {
+  string app_id = 1;
+  map<string, string> tags = 2;
+}
+
+
 message AppStopRequest {
-  string app_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string app_id = 1;
   AppStopSource source = 2;
 }
 
@@ -715,6 +731,7 @@ message BuildFunction {
 message CancelInputEvent {
   repeated string input_ids = 1;
   bool terminate_containers = 2;
+  string cancellation_reason = 3;
 }
 
 message CheckpointInfo {
@@ -730,7 +747,7 @@ message CheckpointInfo {
 }
 
 message ClassCreateRequest {
-  string app_id = 1  [ (modal.options.audit_target_attr) = true ];
+  string app_id = 1 ;
   string existing_class_id = 2;
   repeated ClassMethod methods = 3;
   reserved 4; // removed class_function_id
@@ -835,6 +852,12 @@ message CloudBucketMount {
     GCP = 3;
   }
 
+  enum MetadataTTLType {
+    METADATA_TTL_TYPE_UNSPECIFIED = 0;
+    METADATA_TTL_TYPE_MINIMAL = 1;
+    METADATA_TTL_TYPE_INDEFINITE = 2;
+  }
+
   string bucket_name = 1;
   string mount_path = 2;
   string credentials_secret_id = 3;
@@ -844,6 +867,11 @@ message CloudBucketMount {
   optional string bucket_endpoint_url = 7;
   optional string key_prefix = 8;
   optional string oidc_auth_role_arn = 9;
+  bool force_path_style = 10;
+  oneof metadata_ttl_oneof {
+    MetadataTTLType metadata_ttl_type = 11;
+    uint64 metadata_ttl_seconds = 12;
+  }
 }
 
 message ClusterGetRequest {
@@ -1064,7 +1092,7 @@ message ContainerReloadVolumesRequest {
 message ContainerReloadVolumesResponse { }
 
 message ContainerStopRequest {
-  string task_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string task_id = 1;
 }
 
 message ContainerStopResponse {
@@ -1132,7 +1160,7 @@ message DictEntry {
 }
 
 message DictGetOrCreateRequest {
-  string deployment_name = 1 [ (modal.options.audit_target_attr) = true ];
+  string deployment_name = 1;
   reserved 2; // removed namespace
   string environment_name = 3;
   ObjectCreationType object_creation_type = 4;
@@ -1199,7 +1227,7 @@ message DictPopResponse {
 }
 
 message DictUpdateRequest {
-  string dict_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string dict_id = 1;
   repeated DictEntry updates = 2;
   bool if_not_exists = 3;
 }
@@ -1225,7 +1253,7 @@ message DomainCertificateVerifyResponse {
 }
 
 message DomainCreateRequest {
-  string domain_name = 1  [ (modal.options.audit_target_attr) = true ];
+  string domain_name = 1 ;
 }
 
 message DomainCreateResponse {
@@ -1241,14 +1269,14 @@ message DomainListResponse {
 }
 
 message EnvironmentCreateRequest {
-  string name = 1 [ (modal.options.audit_target_attr) = true ];
+  string name = 1;
 }
 
 message EnvironmentDeleteRequest {
-  string name = 1 [ (modal.options.audit_target_attr) = true ];
+  string name = 1;
 }
 message EnvironmentGetOrCreateRequest {
-  string deployment_name = 1 [ (modal.options.audit_target_attr) = true ];
+  string deployment_name = 1;
   ObjectCreationType object_creation_type = 2;
 }
 
@@ -1264,6 +1292,10 @@ message EnvironmentListItem {
   bool default = 4;
   bool is_managed = 5;
   string environment_id = 6;
+  optional int32 max_concurrent_tasks = 7;
+  optional int32 max_concurrent_gpus = 8;
+  int32 current_concurrent_tasks = 9;
+  int32 current_concurrent_gpus = 10;
 }
 
 message EnvironmentListResponse {
@@ -1284,9 +1316,11 @@ message EnvironmentSettings {
 }
 
 message EnvironmentUpdateRequest {
-  string current_name = 1 [ (modal.options.audit_target_attr) = true ];
+  string current_name = 1;
   google.protobuf.StringValue name = 2;
   google.protobuf.StringValue web_suffix = 3;
+  optional int32 max_concurrent_tasks = 4;
+  optional int32 max_concurrent_gpus = 5;
 }
 
 // A file entry when listing files in a volume or network file system.
@@ -1343,7 +1377,7 @@ message FlashContainerRegisterResponse {
 
 message FlashProxyUpstreamRequest {
   uint32 upstream_requests = 1;
-  double timestamp = 2; 
+  double timestamp = 2;
 }
 
 message FlashSetTargetSlotsMetricsRequest {
@@ -1435,6 +1469,8 @@ message Function {
 
   bool block_network = 44;
 
+  // In the SDK, we've deprecated `max_inputs` (which only every implemented `max_inputs=1`)
+  // in favor of a boolean `single_use_containers` parameter.
   uint32 max_inputs = 46;
 
   repeated S3Mount s3_mounts = 47;
@@ -1517,6 +1553,14 @@ message Function {
   uint32 startup_timeout_secs = 86;
   repeated DataFormat supported_input_formats = 87; // can be used as inputs
   repeated DataFormat supported_output_formats = 88;
+  optional HTTPConfig http_config = 89;
+
+  // Attribute on the module with the implementation, which may differ from function_name
+  // when the user provided a custom name= for the Function inside the Application namespace
+  string implementation_name = 90;
+
+  bool single_use_containers = 91; // When True, containers will shut down after handling a single input
+
 }
 
 message FunctionAsyncInvokeRequest {
@@ -1572,6 +1616,7 @@ message FunctionCallGetDataRequest {
     string attempt_token = 3;
   }
   uint64 last_index = 2;
+  bool use_gapless_read = 4;
 }
 
 message FunctionCallInfo {
@@ -1607,7 +1652,7 @@ message FunctionCallPutDataRequest {
 
 message FunctionCreateRequest {
   Function function = 1;
-  string app_id = 2  [ (modal.options.audit_target_attr) = true ];
+  string app_id = 2 ;
   Schedule schedule = 6 [deprecated=true]; // Deprecated: now passed in the Function definition
   string existing_function_id = 7;
   reserved 8;  // defer_updates
@@ -1694,6 +1739,11 @@ message FunctionData {
   uint32 startup_timeout_secs = 36;
   repeated DataFormat supported_input_formats = 37;
   repeated DataFormat supported_output_formats = 38;
+  optional HTTPConfig http_config = 39;
+
+  // Attribute on the module with the implementation, which may differ from function_name
+  // when the user provided a custom name= for the Function inside the Application namespace
+  string implementation_name = 40;
 }
 
 message FunctionExtended {
@@ -1902,7 +1952,7 @@ message FunctionOptions {
 
 message FunctionPrecreateRequest {
   string app_id = 1;
-  string function_name = 2  [ (modal.options.audit_target_attr) = true ];
+  string function_name = 2 ;
   string existing_function_id = 3;
   Function.FunctionType function_type = 4;
   WebhookConfig webhook_config = 5;
@@ -1951,8 +2001,8 @@ message FunctionPutOutputsItem {
   double output_created_at = 4;
   DataFormat data_format = 7; // for result.data_oneof
   uint32 retry_count = 8;
-  string function_call_id = 9; // injected by the worker 
-  optional int32 function_map_idx = 10; // injected by the worker 
+  string function_call_id = 9; // injected by the worker
+  optional int32 function_map_idx = 10; // injected by the worker
 }
 
 message FunctionPutOutputsRequest {
@@ -2012,6 +2062,7 @@ message GPUConfig {
   string gpu_type = 4;
 }
 
+
 message GeneratorDone {  // Sent as the output when a generator finishes running.
   uint64 items_total = 1;
 }
@@ -2053,6 +2104,14 @@ message GenericResult {  // Used for both tasks and function outputs
   string propagation_reason = 13; // (?)
 }
 
+message HTTPConfig {
+  uint32 port = 1;
+  repeated string proxy_regions = 2;
+  uint32 startup_timeout = 3;
+  uint32 exit_grace_period = 4;
+  bool h2_enabled = 5;
+}
+
 message Image {
   repeated BaseImage base_images = 5;
   repeated string dockerfile_commands = 6;
@@ -2102,7 +2161,7 @@ message ImageFromIdResponse {
 
 message ImageGetOrCreateRequest {
   Image image = 2;
-  string app_id = 4 [ (modal.options.audit_target_attr) = true ];
+  string app_id = 4;
   string existing_image_id = 5;  // ignored
   string build_function_id = 6;
   bool force_build = 7;
@@ -2212,7 +2271,7 @@ message MapAwaitResponse {
 message MapCheckInputsRequest {
   string last_entry_id = 1;
   float timeout = 2;
-  repeated string attempt_tokens = 3;  
+  repeated string attempt_tokens = 3;
 }
 
 message MapCheckInputsResponse {
@@ -2433,12 +2492,13 @@ message Proxy {
   string name = 1;
   double created_at = 2;
   string environment_name = 3;
-  string proxy_id = 5;
   repeated ProxyIp proxy_ips = 4;
+  string proxy_id = 5;
+  string region = 6;
 }
 
 message ProxyAddIpRequest {
-  string proxy_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string proxy_id = 1;
 }
 
 message ProxyAddIpResponse {
@@ -2446,8 +2506,9 @@ message ProxyAddIpResponse {
 }
 
 message ProxyCreateRequest {
-  string name = 1 [ (modal.options.audit_target_attr) = true ];
+  string name = 1;
   string environment_name = 2;
+  string region = 3;
 }
 
 message ProxyCreateResponse {
@@ -2455,11 +2516,11 @@ message ProxyCreateResponse {
 }
 
 message ProxyDeleteRequest {
-  string proxy_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string proxy_id = 1;
 }
 
 message ProxyGetOrCreateRequest {
-  string deployment_name = 1 [ (modal.options.audit_target_attr) = true ];
+  string deployment_name = 1;
   reserved 2; // namespace
   string environment_name = 3;
   ObjectCreationType object_creation_type = 4;  // must be UNSPECIFIED
@@ -2470,7 +2531,7 @@ message ProxyGetOrCreateResponse {
 }
 
 message ProxyGetRequest {
-  string name = 1 [ (modal.options.audit_target_attr) = true ];
+  string name = 1;
   string environment_name = 2;
 }
 
@@ -2498,7 +2559,7 @@ message ProxyListResponse {
 }
 
 message ProxyRemoveIpRequest {
-  string proxy_ip = 1 [ (modal.options.audit_target_attr) = true ];
+  string proxy_ip = 1;
 }
 
 message QueueClearRequest {
@@ -2508,7 +2569,7 @@ message QueueClearRequest {
 }
 
 message QueueDeleteRequest {
-  string queue_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string queue_id = 1;
 }
 
 message QueueGetOrCreateRequest {
@@ -2596,6 +2657,22 @@ message QueuePutRequest {
   int32 partition_ttl_seconds = 6;
 }
 
+// Retry repolicy used by GRPCError.details for the server to give instructions
+// for the client to retry.
+message RPCRetryPolicy {
+  float retry_after_secs = 1;
+}
+
+// A copy google.rpc.Status for GRPCError.details:
+// https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto
+// RPCStatus is compatible with google.rpc.Status, so one can encode messages using
+// google.rpc.Status. The `details` field can be a list of any message, but for client
+// to decode it, the messages should be defined here (`modal_proto`).
+message RPCStatus {
+  int32 code = 1;
+  string message = 2;
+  repeated google.protobuf.Any details = 3;
+}
 
 message RateLimit {
   int32 limit = 1;
@@ -2722,6 +2799,11 @@ message Sandbox {
   // Exec commands for the sandbox will be issued directly to the sandbox
   // command router running on the Modal worker.
   bool direct_sandbox_commands_enabled = 34;
+
+  // Internal: restricts sandbox to run on this specific instance type.
+  // Set by server during SandboxRestore to ensure the restored sandbox runs
+  // on the same instance type as the original snapshot.
+  string _restore_instance_type = 35;
 }
 
 message SandboxCreateConnectTokenRequest {
@@ -2735,7 +2817,7 @@ message SandboxCreateConnectTokenResponse {
 }
 
 message SandboxCreateRequest {
-  string app_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string app_id = 1;
   Sandbox definition = 2;
   string environment_name = 3; // *DEPRECATED* 7/16/2025
 }
@@ -2744,18 +2826,6 @@ message SandboxCreateResponse {
   string sandbox_id = 1;
 }
 
-// Used to get a JWT and URL for direct access to a sandbox router server
-// running on the modal-worker, so the client can issue exec commands (and other
-// operations as they become available) directly to the worker.
-message SandboxGetCommandRouterAccessRequest {
-  string sandbox_id = 1;
-}
-
-message SandboxGetCommandRouterAccessResponse {
-  string jwt = 1;
-  string url = 2;
-}
-
 message SandboxGetFromNameRequest {
   string sandbox_name = 1;
   string environment_name = 2;
@@ -2816,7 +2886,7 @@ message SandboxInfo {
   string app_id = 5;
   repeated SandboxTag tags = 6; // TODO: Not yet exposed in client library.
   string name = 7;
-
+  string image_id = 8;
   reserved 2; // modal.client.Sandbox definition
 }
 
@@ -2964,24 +3034,20 @@ message Schedule {
   }
 }
 
+// Scheduling constraints for Functions and Sandboxes.
 message SchedulerPlacement {
-  // TODO(irfansharif):
-  // - Fold in cloud, resource needs here too.
-  // - Allow specifying list of zones, cloud, fallback and alternative
-  //   GPU types.
-
   repeated string regions = 4;
-  // TODO(irfansharif): Make these two repeated.
-  optional string _zone = 2; // admin-only
-  optional string _lifecycle = 3; // admin-only, "on-demand" or "spot", else ignored
-  repeated string _instance_types = 5; // admin-only
+  optional string _zone = 2 [deprecated = true];
+  optional string _lifecycle = 3 [deprecated = true];
+  repeated string _instance_types = 5 [deprecated = true];
+  bool nonpreemptible = 6;  // Functions only
 
   reserved 1;
 }
 
 message SecretCreateRequest {  // Not used by client anymore
   map<string, string> env_dict = 1;
-  string app_id = 2 [ (modal.options.audit_target_attr) = true ];
+  string app_id = 2;
   string template_type = 3;  // todo: not used?
   string existing_secret_id = 4;
 }
@@ -2995,7 +3061,7 @@ message SecretDeleteRequest {
 }
 
 message SecretGetOrCreateRequest {
-  string deployment_name = 1 [ (modal.options.audit_target_attr) = true ];
+  string deployment_name = 1;
   reserved 2; // removed namespace
   string environment_name = 3;
   ObjectCreationType object_creation_type = 4;  // Not used atm
@@ -3052,7 +3118,7 @@ message SharedVolumeGetFileResponse {
 }
 
 message SharedVolumeGetOrCreateRequest {
-  string deployment_name = 1 [ (modal.options.audit_target_attr) = true ];
+  string deployment_name = 1;
   reserved 2; // removed namespace
   string environment_name = 3;
   ObjectCreationType object_creation_type = 4;
@@ -3096,11 +3162,11 @@ message SharedVolumeMount {
   string mount_path = 1;
   string shared_volume_id = 2;
   CloudProvider cloud_provider = 3;
-  bool allow_cross_region = 4;
+  reserved 4; // allow_cross_region
 }
 
 message SharedVolumePutFileRequest {
-  string shared_volume_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string shared_volume_id = 1;
   string path = 2;
   string sha256_hex = 3;
   oneof data_oneof {
@@ -3115,7 +3181,7 @@ message SharedVolumePutFileResponse {
 }
 
 message SharedVolumeRemoveFileRequest {
-  string shared_volume_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string shared_volume_id = 1;
   string path = 2;
   bool recursive = 3;
 }
@@ -3142,12 +3208,16 @@ message TaskCurrentInputsResponse {
   repeated string input_ids = 1;
 }
 
-message TaskGetAutoscalingMetricsRequest {
+// Used to get a JWT and URL for direct access to a task command router
+// running on the modal-worker, so the client can issue exec commands (and other
+// operations as they become available) directly to the worker.
+message TaskGetCommandRouterAccessRequest {
   string task_id = 1;
 }
 
-message TaskGetAutoscalingMetricsResponse {
-  AutoscalingMetrics metrics = 1;
+message TaskGetCommandRouterAccessResponse {
+  string jwt = 1;
+  string url = 2;
 }
 
 message TaskInfo {
@@ -3292,7 +3362,7 @@ message UserActionInfo {
 message VolumeCommitRequest {
   // NOTE(staffan): Mounting a volume in multiple locations is not supported, so volume_id alone uniquely identifies
   // a volume mount.
-  string volume_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string volume_id = 1;
 }
 
 message VolumeCommitResponse {
@@ -3350,7 +3420,7 @@ message VolumeGetFileResponse {
 }
 
 message VolumeGetOrCreateRequest {
-  string deployment_name = 1 [ (modal.options.audit_target_attr) = true ];
+  string deployment_name = 1;
   reserved 2; // removed namespace
   string environment_name = 3;
   ObjectCreationType object_creation_type = 4;
@@ -3502,19 +3572,19 @@ message VolumeReloadRequest {
 }
 
 message VolumeRemoveFile2Request {
-  string volume_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string volume_id = 1;
   string path = 2;
   bool recursive = 3;
 }
 
 message VolumeRemoveFileRequest {
-  string volume_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string volume_id = 1;
   string path = 2;
   bool recursive = 3;
 }
 
 message VolumeRenameRequest {
-  string volume_id = 1 [ (modal.options.audit_target_attr) = true ];
+  string volume_id = 1;
   string name = 2;
 }
 
@@ -3538,16 +3608,16 @@ message WebUrlInfo {
 message WebhookConfig {
   WebhookType type = 1;
   string method = 2;
-  string requested_suffix = 4;
+  string requested_suffix = 4;  // User-supplied "label" component of URL
   WebhookAsyncMode async_mode = 5;
   repeated CustomDomainConfig custom_domains = 6;
   uint32 web_server_port = 7;
   float web_server_startup_timeout = 8;
   bool web_endpoint_docs = 9;
   bool requires_proxy_auth = 10;
+  string ephemeral_suffix = 11;  // Additional URL suffix added for ephemeral Apps
 }
 
-
 message WorkspaceBillingReportItem {
   string object_id = 1;
   string description = 2;
@@ -3582,12 +3652,14 @@ service ModalClient {
   rpc AppGetLogs(AppGetLogsRequest) returns (stream TaskLogsBatch);
   rpc AppGetObjects(AppGetObjectsRequest) returns (AppGetObjectsResponse);
   rpc AppGetOrCreate(AppGetOrCreateRequest) returns (AppGetOrCreateResponse);
+  rpc AppGetTags(AppGetTagsRequest) returns (AppGetTagsResponse);
   rpc AppHeartbeat(AppHeartbeatRequest) returns (google.protobuf.Empty);
   rpc AppList(AppListRequest) returns (AppListResponse);
   rpc AppLookup(AppLookupRequest) returns (AppLookupResponse);
   rpc AppPublish(AppPublishRequest) returns (AppPublishResponse);
   rpc AppRollback(AppRollbackRequest) returns (google.protobuf.Empty);
   rpc AppSetObjects(AppSetObjectsRequest) returns (google.protobuf.Empty);
+  rpc AppSetTags(AppSetTagsRequest) returns (google.protobuf.Empty);
   rpc AppStop(AppStopRequest) returns (google.protobuf.Empty);
 
   // Input Plane
@@ -3725,7 +3797,6 @@ service ModalClient {
   // Sandboxes
   rpc SandboxCreate(SandboxCreateRequest) returns (SandboxCreateResponse);
   rpc SandboxCreateConnectToken(SandboxCreateConnectTokenRequest) returns (SandboxCreateConnectTokenResponse);
-  rpc SandboxGetCommandRouterAccess(SandboxGetCommandRouterAccessRequest) returns (SandboxGetCommandRouterAccessResponse);
   rpc SandboxGetFromName(SandboxGetFromNameRequest) returns (SandboxGetFromNameResponse);
   rpc SandboxGetLogs(SandboxGetLogsRequest) returns (stream TaskLogsBatch);
   rpc SandboxGetResourceUsage(SandboxGetResourceUsageRequest) returns (SandboxGetResourceUsageResponse);
@@ -3764,7 +3835,7 @@ service ModalClient {
   // Tasks
   rpc TaskClusterHello(TaskClusterHelloRequest) returns (TaskClusterHelloResponse);
   rpc TaskCurrentInputs(google.protobuf.Empty) returns (TaskCurrentInputsResponse);
-  rpc TaskGetAutoscalingMetrics(TaskGetAutoscalingMetricsRequest) returns (TaskGetAutoscalingMetricsResponse); // Used for flash autoscaling
+  rpc TaskGetCommandRouterAccess(TaskGetCommandRouterAccessRequest) returns (TaskGetCommandRouterAccessResponse);
   rpc TaskList(TaskListRequest) returns (TaskListResponse);
   rpc TaskResult(TaskResultRequest) returns (google.protobuf.Empty);