@zocomputer/system-api 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generate/types.js +12 -2
- package/dist/generated/catalog.js +116 -56
- package/dist/generated/manifest.json +108 -58
- package/dist/generated/operations.d.ts +1642 -55
- package/dist/generated/schema.json +9492 -2364
- package/openapi.json +9492 -2364
- package/package.json +1 -1
|
@@ -103,8 +103,18 @@ export interface ZoAgentCancelOutputV1 {
|
|
|
103
103
|
state: ("idle" | "cancelling");
|
|
104
104
|
}
|
|
105
105
|
export interface ZoAgentCreateInputV1 {
|
|
106
|
+
/**
|
|
107
|
+
* @maxItems 100
|
|
108
|
+
*
|
|
109
|
+
* Items: A tag ID or name; unknown names are created, unknown IDs are refused.
|
|
110
|
+
*/
|
|
111
|
+
tags?: string[];
|
|
106
112
|
workspace_id: string;
|
|
107
113
|
display_name: string;
|
|
114
|
+
/**
|
|
115
|
+
* Describe what this Agent is for in the user's terms.
|
|
116
|
+
*/
|
|
117
|
+
description?: string;
|
|
108
118
|
visibility?: ("workspace" | "protected");
|
|
109
119
|
implementation: "zo.native";
|
|
110
120
|
configuration: ZoAgentCreateInputV1NativeConfiguration;
|
|
@@ -114,9 +124,13 @@ export interface ZoAgentCreateInputV1 {
|
|
|
114
124
|
*/
|
|
115
125
|
export interface ZoAgentCreateInputV1NativeConfiguration {
|
|
116
126
|
/**
|
|
117
|
-
*
|
|
127
|
+
* The model a new session starts with. Each session keeps its own choice after that.
|
|
118
128
|
*/
|
|
119
129
|
model: string;
|
|
130
|
+
/**
|
|
131
|
+
* The reasoning level a new session starts with, one the model's catalog offers; null for the model's default.
|
|
132
|
+
*/
|
|
133
|
+
reasoning?: (string | null);
|
|
120
134
|
/**
|
|
121
135
|
* The Agent's instructions.
|
|
122
136
|
*/
|
|
@@ -139,6 +153,7 @@ export interface ZoAgentCreateOutputV1 {
|
|
|
139
153
|
type: "agent";
|
|
140
154
|
type_version: number;
|
|
141
155
|
display_name: string;
|
|
156
|
+
description: string;
|
|
142
157
|
revision: number;
|
|
143
158
|
implementation: "zo.native";
|
|
144
159
|
configuration: ZoAgentCreateOutputV1NativeConfiguration;
|
|
@@ -159,9 +174,13 @@ export interface ZoAgentCreateOutputV1 {
|
|
|
159
174
|
*/
|
|
160
175
|
export interface ZoAgentCreateOutputV1NativeConfiguration {
|
|
161
176
|
/**
|
|
162
|
-
*
|
|
177
|
+
* The model a new session starts with. Each session keeps its own choice after that.
|
|
163
178
|
*/
|
|
164
179
|
model: string;
|
|
180
|
+
/**
|
|
181
|
+
* The reasoning level a new session starts with, one the model's catalog offers; null for the model's default.
|
|
182
|
+
*/
|
|
183
|
+
reasoning?: (string | null);
|
|
165
184
|
/**
|
|
166
185
|
* The Agent's instructions.
|
|
167
186
|
*/
|
|
@@ -222,6 +241,7 @@ export interface ZoAgentGetOutputV1 {
|
|
|
222
241
|
type: "agent";
|
|
223
242
|
type_version: number;
|
|
224
243
|
display_name: string;
|
|
244
|
+
description: string;
|
|
225
245
|
revision: number;
|
|
226
246
|
implementation: "zo.native";
|
|
227
247
|
configuration: ZoAgentGetOutputV1NativeConfiguration;
|
|
@@ -242,9 +262,13 @@ export interface ZoAgentGetOutputV1 {
|
|
|
242
262
|
*/
|
|
243
263
|
export interface ZoAgentGetOutputV1NativeConfiguration {
|
|
244
264
|
/**
|
|
245
|
-
*
|
|
265
|
+
* The model a new session starts with. Each session keeps its own choice after that.
|
|
246
266
|
*/
|
|
247
267
|
model: string;
|
|
268
|
+
/**
|
|
269
|
+
* The reasoning level a new session starts with, one the model's catalog offers; null for the model's default.
|
|
270
|
+
*/
|
|
271
|
+
reasoning?: (string | null);
|
|
248
272
|
/**
|
|
249
273
|
* The Agent's instructions.
|
|
250
274
|
*/
|
|
@@ -301,6 +325,7 @@ export interface ZoAgentListOutputV1Agent {
|
|
|
301
325
|
type: "agent";
|
|
302
326
|
type_version: number;
|
|
303
327
|
display_name: string;
|
|
328
|
+
description: string;
|
|
304
329
|
revision: number;
|
|
305
330
|
implementation: "zo.native";
|
|
306
331
|
configuration: ZoAgentListOutputV1NativeConfiguration;
|
|
@@ -321,9 +346,13 @@ export interface ZoAgentListOutputV1Agent {
|
|
|
321
346
|
*/
|
|
322
347
|
export interface ZoAgentListOutputV1NativeConfiguration {
|
|
323
348
|
/**
|
|
324
|
-
*
|
|
349
|
+
* The model a new session starts with. Each session keeps its own choice after that.
|
|
325
350
|
*/
|
|
326
351
|
model: string;
|
|
352
|
+
/**
|
|
353
|
+
* The reasoning level a new session starts with, one the model's catalog offers; null for the model's default.
|
|
354
|
+
*/
|
|
355
|
+
reasoning?: (string | null);
|
|
327
356
|
/**
|
|
328
357
|
* The Agent's instructions.
|
|
329
358
|
*/
|
|
@@ -451,6 +480,14 @@ export interface ZoAgentListMessagesOutputV1MessageDelivery {
|
|
|
451
480
|
*/
|
|
452
481
|
outcome: (("completed" | "cancelled" | "interrupted" | "failed") | null);
|
|
453
482
|
outcome_reason: (string | null);
|
|
483
|
+
/**
|
|
484
|
+
* The model the message was admitted with: the one it named, else the session's.
|
|
485
|
+
*/
|
|
486
|
+
model: (string | null);
|
|
487
|
+
/**
|
|
488
|
+
* The reasoning level the message was admitted with; null for the model's default.
|
|
489
|
+
*/
|
|
490
|
+
reasoning: (string | null);
|
|
454
491
|
}
|
|
455
492
|
export interface ZoAgentListMessagesQueryV1 {
|
|
456
493
|
/**
|
|
@@ -477,6 +514,14 @@ export interface ZoAgentSendInputV1 {
|
|
|
477
514
|
* How the message affects work already running in the session: wait behind it, join it, or stop it.
|
|
478
515
|
*/
|
|
479
516
|
priority?: ("queue" | "steer" | "interrupt");
|
|
517
|
+
/**
|
|
518
|
+
* Make this the session's model, from the turn this message starts; a steer that joins a running turn changes the next one. Omit to keep the session's choice.
|
|
519
|
+
*/
|
|
520
|
+
model?: (string | null);
|
|
521
|
+
/**
|
|
522
|
+
* The model's reasoning level; null for the model's default. Requires model.
|
|
523
|
+
*/
|
|
524
|
+
reasoning?: (string | null);
|
|
480
525
|
}
|
|
481
526
|
export interface ZoAgentSendInputV1TextBlock {
|
|
482
527
|
type: "text";
|
|
@@ -526,6 +571,10 @@ export interface ZoAgentUpdateInputV1 {
|
|
|
526
571
|
agent_id: string;
|
|
527
572
|
expected_revision: number;
|
|
528
573
|
display_name?: (string | null);
|
|
574
|
+
/**
|
|
575
|
+
* Describe what this Agent is for in the user's terms.
|
|
576
|
+
*/
|
|
577
|
+
description?: (string | null);
|
|
529
578
|
configuration?: (ZoAgentUpdateInputV1NativeConfiguration | null);
|
|
530
579
|
}
|
|
531
580
|
/**
|
|
@@ -533,9 +582,13 @@ export interface ZoAgentUpdateInputV1 {
|
|
|
533
582
|
*/
|
|
534
583
|
export interface ZoAgentUpdateInputV1NativeConfiguration {
|
|
535
584
|
/**
|
|
536
|
-
*
|
|
585
|
+
* The model a new session starts with. Each session keeps its own choice after that.
|
|
537
586
|
*/
|
|
538
587
|
model: string;
|
|
588
|
+
/**
|
|
589
|
+
* The reasoning level a new session starts with, one the model's catalog offers; null for the model's default.
|
|
590
|
+
*/
|
|
591
|
+
reasoning?: (string | null);
|
|
539
592
|
/**
|
|
540
593
|
* The Agent's instructions.
|
|
541
594
|
*/
|
|
@@ -558,6 +611,7 @@ export interface ZoAgentUpdateOutputV1 {
|
|
|
558
611
|
type: "agent";
|
|
559
612
|
type_version: number;
|
|
560
613
|
display_name: string;
|
|
614
|
+
description: string;
|
|
561
615
|
revision: number;
|
|
562
616
|
implementation: "zo.native";
|
|
563
617
|
configuration: ZoAgentUpdateOutputV1NativeConfiguration;
|
|
@@ -578,9 +632,13 @@ export interface ZoAgentUpdateOutputV1 {
|
|
|
578
632
|
*/
|
|
579
633
|
export interface ZoAgentUpdateOutputV1NativeConfiguration {
|
|
580
634
|
/**
|
|
581
|
-
*
|
|
635
|
+
* The model a new session starts with. Each session keeps its own choice after that.
|
|
582
636
|
*/
|
|
583
637
|
model: string;
|
|
638
|
+
/**
|
|
639
|
+
* The reasoning level a new session starts with, one the model's catalog offers; null for the model's default.
|
|
640
|
+
*/
|
|
641
|
+
reasoning?: (string | null);
|
|
584
642
|
/**
|
|
585
643
|
* The Agent's instructions.
|
|
586
644
|
*/
|
|
@@ -639,6 +697,14 @@ export interface ZoAgentSessionGetOutputV1 {
|
|
|
639
697
|
* When the session's newest message or event was delivered to it; created_at when it has none.
|
|
640
698
|
*/
|
|
641
699
|
last_activity_at: string;
|
|
700
|
+
/**
|
|
701
|
+
* The model the session's next inputs run with.
|
|
702
|
+
*/
|
|
703
|
+
model: string;
|
|
704
|
+
/**
|
|
705
|
+
* The reasoning level the session's next inputs run with; null for the model's default.
|
|
706
|
+
*/
|
|
707
|
+
reasoning: (string | null);
|
|
642
708
|
/**
|
|
643
709
|
* Server-sent events of the session's history, then its live output, read with the same Bearer credential. Authorized as zo.agent_session.history.
|
|
644
710
|
*/
|
|
@@ -697,6 +763,14 @@ export interface ZoAgentSessionListOutputV1AgentSession {
|
|
|
697
763
|
* When the session's newest message or event was delivered to it; created_at when it has none.
|
|
698
764
|
*/
|
|
699
765
|
last_activity_at: string;
|
|
766
|
+
/**
|
|
767
|
+
* The model the session's next inputs run with.
|
|
768
|
+
*/
|
|
769
|
+
model: string;
|
|
770
|
+
/**
|
|
771
|
+
* The reasoning level the session's next inputs run with; null for the model's default.
|
|
772
|
+
*/
|
|
773
|
+
reasoning: (string | null);
|
|
700
774
|
}
|
|
701
775
|
export interface ZoAgentSessionListQueryV1 {
|
|
702
776
|
/**
|
|
@@ -729,6 +803,14 @@ export interface ZoAgentSessionListWorkspaceOutputV1AgentSession {
|
|
|
729
803
|
* When the session's newest message or event was delivered to it; created_at when it has none.
|
|
730
804
|
*/
|
|
731
805
|
last_activity_at: string;
|
|
806
|
+
/**
|
|
807
|
+
* The model the session's next inputs run with.
|
|
808
|
+
*/
|
|
809
|
+
model: string;
|
|
810
|
+
/**
|
|
811
|
+
* The reasoning level the session's next inputs run with; null for the model's default.
|
|
812
|
+
*/
|
|
813
|
+
reasoning: (string | null);
|
|
732
814
|
}
|
|
733
815
|
export interface ZoAgentSessionListWorkspaceQueryV1 {
|
|
734
816
|
/**
|
|
@@ -747,6 +829,298 @@ export interface ZoAgentSessionListWorkspaceQueryV1 {
|
|
|
747
829
|
agent_id?: (string | null);
|
|
748
830
|
};
|
|
749
831
|
}
|
|
832
|
+
export interface ZoBillingListRatesInputV1 {
|
|
833
|
+
workspace_id: string;
|
|
834
|
+
}
|
|
835
|
+
export interface ZoBillingListRatesOutputV1 {
|
|
836
|
+
workspace_id: string;
|
|
837
|
+
observed_at: string;
|
|
838
|
+
rates: ZoBillingListRatesOutputV1BillingRate[];
|
|
839
|
+
next_cursor: (string | null);
|
|
840
|
+
}
|
|
841
|
+
export interface ZoBillingListRatesOutputV1BillingRate {
|
|
842
|
+
/**
|
|
843
|
+
* Current catalog key; not an immutable historical price identifier.
|
|
844
|
+
*/
|
|
845
|
+
rate_key: string;
|
|
846
|
+
product: string;
|
|
847
|
+
meter: string;
|
|
848
|
+
price: ZoBillingListRatesOutputV1AppliedPrice;
|
|
849
|
+
model_id?: (string | null);
|
|
850
|
+
tool_name?: (string | null);
|
|
851
|
+
provider?: (string | null);
|
|
852
|
+
sku?: (string | null);
|
|
853
|
+
resource_kind?: (string | null);
|
|
854
|
+
conditions?: ZoBillingListRatesOutputV1RateConditions;
|
|
855
|
+
promotional_end?: (string | null);
|
|
856
|
+
applicability?: ("active" | "no_usage_feed");
|
|
857
|
+
}
|
|
858
|
+
export interface ZoBillingListRatesOutputV1AppliedPrice {
|
|
859
|
+
amount: string;
|
|
860
|
+
currency?: "USD";
|
|
861
|
+
per: ZoBillingListRatesOutputV1BillingQuantity;
|
|
862
|
+
tariff_version?: (string | null);
|
|
863
|
+
usage_price_multiplier?: (string | null);
|
|
864
|
+
}
|
|
865
|
+
export interface ZoBillingListRatesOutputV1BillingQuantity {
|
|
866
|
+
amount: string;
|
|
867
|
+
unit: string;
|
|
868
|
+
}
|
|
869
|
+
export interface ZoBillingListRatesOutputV1RateConditions {
|
|
870
|
+
/**
|
|
871
|
+
* Inclusive request-size lower bound.
|
|
872
|
+
*/
|
|
873
|
+
request_input_tokens_min?: (number | null);
|
|
874
|
+
/**
|
|
875
|
+
* Exclusive request-size upper bound.
|
|
876
|
+
*/
|
|
877
|
+
request_input_tokens_max?: (number | null);
|
|
878
|
+
/**
|
|
879
|
+
* The matching tier prices the whole request.
|
|
880
|
+
*/
|
|
881
|
+
whole_request?: boolean;
|
|
882
|
+
operation?: (string | null);
|
|
883
|
+
resolution?: (string | null);
|
|
884
|
+
quality?: (string | null);
|
|
885
|
+
duration_seconds?: (string | null);
|
|
886
|
+
quantity_min?: (string | null);
|
|
887
|
+
quantity_max?: (string | null);
|
|
888
|
+
included_quantity?: (string | null);
|
|
889
|
+
default_quantity?: (string | null);
|
|
890
|
+
quantity_argument?: (string | null);
|
|
891
|
+
selector?: {
|
|
892
|
+
[k: string]: JsonValue;
|
|
893
|
+
};
|
|
894
|
+
rounding?: ("none" | "ceil_step");
|
|
895
|
+
}
|
|
896
|
+
export interface ZoBillingListRatesQueryV1 {
|
|
897
|
+
/**
|
|
898
|
+
* Rows per page, at most 200; a larger value is reduced to it.
|
|
899
|
+
*/
|
|
900
|
+
limit?: number;
|
|
901
|
+
/**
|
|
902
|
+
* The previous page's next_cursor, sent with the same sort, filter and search.
|
|
903
|
+
*/
|
|
904
|
+
cursor?: string;
|
|
905
|
+
sort?: "rate_key.asc";
|
|
906
|
+
filter?: {
|
|
907
|
+
product?: (string | null);
|
|
908
|
+
meter?: (string | null);
|
|
909
|
+
model_id?: (string | null);
|
|
910
|
+
tool_name?: (string | null);
|
|
911
|
+
provider?: (string | null);
|
|
912
|
+
sku?: (string | null);
|
|
913
|
+
};
|
|
914
|
+
}
|
|
915
|
+
export interface ZoBillingListUsageEntriesInputV1 {
|
|
916
|
+
workspace_id: string;
|
|
917
|
+
period: ZoBillingListUsageEntriesInputV1BillingPeriod;
|
|
918
|
+
}
|
|
919
|
+
export interface ZoBillingListUsageEntriesInputV1BillingPeriod {
|
|
920
|
+
/**
|
|
921
|
+
* An ISO 8601 timestamp with a time zone.
|
|
922
|
+
*/
|
|
923
|
+
start: string;
|
|
924
|
+
/**
|
|
925
|
+
* An ISO 8601 timestamp with a time zone.
|
|
926
|
+
*/
|
|
927
|
+
end: string;
|
|
928
|
+
}
|
|
929
|
+
export interface ZoBillingListUsageEntriesOutputV1 {
|
|
930
|
+
workspace_id: string;
|
|
931
|
+
period: ZoBillingListUsageEntriesOutputV1BillingPeriod;
|
|
932
|
+
history_mode?: "forward_only";
|
|
933
|
+
observed_at: string;
|
|
934
|
+
entries: ZoBillingListUsageEntriesOutputV1UsageEntry[];
|
|
935
|
+
next_cursor: (string | null);
|
|
936
|
+
}
|
|
937
|
+
export interface ZoBillingListUsageEntriesOutputV1BillingPeriod {
|
|
938
|
+
/**
|
|
939
|
+
* An ISO 8601 timestamp with a time zone.
|
|
940
|
+
*/
|
|
941
|
+
start: string;
|
|
942
|
+
/**
|
|
943
|
+
* An ISO 8601 timestamp with a time zone.
|
|
944
|
+
*/
|
|
945
|
+
end: string;
|
|
946
|
+
}
|
|
947
|
+
export interface ZoBillingListUsageEntriesOutputV1UsageEntry {
|
|
948
|
+
id: string;
|
|
949
|
+
usage_id: string;
|
|
950
|
+
product: string;
|
|
951
|
+
meter: string;
|
|
952
|
+
quantity: ZoBillingListUsageEntriesOutputV1BillingQuantity;
|
|
953
|
+
cost: ZoBillingListUsageEntriesOutputV1BillingMoney;
|
|
954
|
+
/**
|
|
955
|
+
* Null for an explicit occurrence rounding adjustment.
|
|
956
|
+
*/
|
|
957
|
+
applied_price: (ZoBillingListUsageEntriesOutputV1AppliedPrice | null);
|
|
958
|
+
occurred_at: string;
|
|
959
|
+
recorded_at: string;
|
|
960
|
+
interval_start: (string | null);
|
|
961
|
+
interval_end: (string | null);
|
|
962
|
+
attribution: ZoBillingListUsageEntriesOutputV1UsageAttribution;
|
|
963
|
+
correction_of_entry_id: (string | null);
|
|
964
|
+
correction_of_usage_id: (string | null);
|
|
965
|
+
}
|
|
966
|
+
export interface ZoBillingListUsageEntriesOutputV1BillingQuantity {
|
|
967
|
+
amount: string;
|
|
968
|
+
unit: string;
|
|
969
|
+
}
|
|
970
|
+
export interface ZoBillingListUsageEntriesOutputV1BillingMoney {
|
|
971
|
+
amount: string;
|
|
972
|
+
currency?: "USD";
|
|
973
|
+
}
|
|
974
|
+
export interface ZoBillingListUsageEntriesOutputV1AppliedPrice {
|
|
975
|
+
amount: string;
|
|
976
|
+
currency?: "USD";
|
|
977
|
+
per: ZoBillingListUsageEntriesOutputV1BillingQuantity;
|
|
978
|
+
tariff_version?: (string | null);
|
|
979
|
+
usage_price_multiplier?: (string | null);
|
|
980
|
+
}
|
|
981
|
+
export interface ZoBillingListUsageEntriesOutputV1UsageAttribution {
|
|
982
|
+
model_id?: (string | null);
|
|
983
|
+
resource_id?: (string | null);
|
|
984
|
+
/**
|
|
985
|
+
* Current name, including protected resources; null if unavailable.
|
|
986
|
+
*/
|
|
987
|
+
resource_name?: (string | null);
|
|
988
|
+
agent_id?: (string | null);
|
|
989
|
+
agent_session_id?: (string | null);
|
|
990
|
+
agent_session_name?: (string | null);
|
|
991
|
+
turn_id?: (string | null);
|
|
992
|
+
host_id?: (string | null);
|
|
993
|
+
conversation_id?: (string | null);
|
|
994
|
+
run_id?: (string | null);
|
|
995
|
+
tool_call_id?: (string | null);
|
|
996
|
+
tool_name?: (string | null);
|
|
997
|
+
provider?: (string | null);
|
|
998
|
+
sku?: (string | null);
|
|
999
|
+
bucket?: (string | null);
|
|
1000
|
+
operation?: (string | null);
|
|
1001
|
+
attribution_kind?: (string | null);
|
|
1002
|
+
provider_request_id?: (string | null);
|
|
1003
|
+
catalog_revision?: (string | null);
|
|
1004
|
+
gpu_type?: (string | null);
|
|
1005
|
+
storage_component?: (string | null);
|
|
1006
|
+
billing_model_slug?: (string | null);
|
|
1007
|
+
output_count?: (number | null);
|
|
1008
|
+
}
|
|
1009
|
+
export interface ZoBillingListUsageEntriesQueryV1 {
|
|
1010
|
+
/**
|
|
1011
|
+
* Rows per page, at most 200; a larger value is reduced to it.
|
|
1012
|
+
*/
|
|
1013
|
+
limit?: number;
|
|
1014
|
+
/**
|
|
1015
|
+
* The previous page's next_cursor, sent with the same sort, filter and search.
|
|
1016
|
+
*/
|
|
1017
|
+
cursor?: string;
|
|
1018
|
+
sort?: ("occurred_at.desc" | "occurred_at.asc");
|
|
1019
|
+
filter?: {
|
|
1020
|
+
product?: (string | null);
|
|
1021
|
+
meter?: (string | null);
|
|
1022
|
+
model_id?: (string | null);
|
|
1023
|
+
resource_id?: (string | null);
|
|
1024
|
+
agent_id?: (string | null);
|
|
1025
|
+
agent_session_id?: (string | null);
|
|
1026
|
+
turn_id?: (string | null);
|
|
1027
|
+
usage_id?: (string | null);
|
|
1028
|
+
};
|
|
1029
|
+
}
|
|
1030
|
+
export interface ZoBillingSummarizeUsageInputV1 {
|
|
1031
|
+
workspace_id: string;
|
|
1032
|
+
period: ZoBillingSummarizeUsageInputV1BillingPeriod;
|
|
1033
|
+
/**
|
|
1034
|
+
* @maxItems 4
|
|
1035
|
+
*/
|
|
1036
|
+
group_by?: [] | [("product" | "meter" | "model_id" | "resource_id" | "agent_id" | "agent_session_id" | "turn_id" | "usage_id")] | [("product" | "meter" | "model_id" | "resource_id" | "agent_id" | "agent_session_id" | "turn_id" | "usage_id"), ("product" | "meter" | "model_id" | "resource_id" | "agent_id" | "agent_session_id" | "turn_id" | "usage_id")] | [("product" | "meter" | "model_id" | "resource_id" | "agent_id" | "agent_session_id" | "turn_id" | "usage_id"), ("product" | "meter" | "model_id" | "resource_id" | "agent_id" | "agent_session_id" | "turn_id" | "usage_id"), ("product" | "meter" | "model_id" | "resource_id" | "agent_id" | "agent_session_id" | "turn_id" | "usage_id")] | [("product" | "meter" | "model_id" | "resource_id" | "agent_id" | "agent_session_id" | "turn_id" | "usage_id"), ("product" | "meter" | "model_id" | "resource_id" | "agent_id" | "agent_session_id" | "turn_id" | "usage_id"), ("product" | "meter" | "model_id" | "resource_id" | "agent_id" | "agent_session_id" | "turn_id" | "usage_id"), ("product" | "meter" | "model_id" | "resource_id" | "agent_id" | "agent_session_id" | "turn_id" | "usage_id")];
|
|
1037
|
+
/**
|
|
1038
|
+
* Add UTC calendar-day buckets to each group.
|
|
1039
|
+
*/
|
|
1040
|
+
daily?: boolean;
|
|
1041
|
+
}
|
|
1042
|
+
export interface ZoBillingSummarizeUsageInputV1BillingPeriod {
|
|
1043
|
+
/**
|
|
1044
|
+
* An ISO 8601 timestamp with a time zone.
|
|
1045
|
+
*/
|
|
1046
|
+
start: string;
|
|
1047
|
+
/**
|
|
1048
|
+
* An ISO 8601 timestamp with a time zone.
|
|
1049
|
+
*/
|
|
1050
|
+
end: string;
|
|
1051
|
+
}
|
|
1052
|
+
export interface ZoBillingSummarizeUsageOutputV1 {
|
|
1053
|
+
workspace_id: string;
|
|
1054
|
+
period: ZoBillingSummarizeUsageOutputV1BillingPeriod;
|
|
1055
|
+
history_mode?: "forward_only";
|
|
1056
|
+
observed_at: string;
|
|
1057
|
+
recorded_cost: ZoBillingSummarizeUsageOutputV1BillingMoney;
|
|
1058
|
+
entry_count: number;
|
|
1059
|
+
groups: ZoBillingSummarizeUsageOutputV1UsageGroup[];
|
|
1060
|
+
next_cursor: (string | null);
|
|
1061
|
+
}
|
|
1062
|
+
export interface ZoBillingSummarizeUsageOutputV1BillingPeriod {
|
|
1063
|
+
/**
|
|
1064
|
+
* An ISO 8601 timestamp with a time zone.
|
|
1065
|
+
*/
|
|
1066
|
+
start: string;
|
|
1067
|
+
/**
|
|
1068
|
+
* An ISO 8601 timestamp with a time zone.
|
|
1069
|
+
*/
|
|
1070
|
+
end: string;
|
|
1071
|
+
}
|
|
1072
|
+
/**
|
|
1073
|
+
* Signed cost over every matching recorded entry, across all pages.
|
|
1074
|
+
*/
|
|
1075
|
+
export interface ZoBillingSummarizeUsageOutputV1BillingMoney {
|
|
1076
|
+
amount: string;
|
|
1077
|
+
currency?: "USD";
|
|
1078
|
+
}
|
|
1079
|
+
export interface ZoBillingSummarizeUsageOutputV1UsageGroup {
|
|
1080
|
+
/**
|
|
1081
|
+
* Stable opaque ordering key for this combination of dimensions and UTC day.
|
|
1082
|
+
*/
|
|
1083
|
+
key: string;
|
|
1084
|
+
dimensions: ZoBillingSummarizeUsageOutputV1UsageFilter;
|
|
1085
|
+
day: (string | null);
|
|
1086
|
+
recorded_cost: ZoBillingSummarizeUsageOutputV1BillingMoney1;
|
|
1087
|
+
entry_count: number;
|
|
1088
|
+
}
|
|
1089
|
+
export interface ZoBillingSummarizeUsageOutputV1UsageFilter {
|
|
1090
|
+
product?: (string | null);
|
|
1091
|
+
meter?: (string | null);
|
|
1092
|
+
model_id?: (string | null);
|
|
1093
|
+
resource_id?: (string | null);
|
|
1094
|
+
agent_id?: (string | null);
|
|
1095
|
+
agent_session_id?: (string | null);
|
|
1096
|
+
turn_id?: (string | null);
|
|
1097
|
+
usage_id?: (string | null);
|
|
1098
|
+
}
|
|
1099
|
+
export interface ZoBillingSummarizeUsageOutputV1BillingMoney1 {
|
|
1100
|
+
amount: string;
|
|
1101
|
+
currency?: "USD";
|
|
1102
|
+
}
|
|
1103
|
+
export interface ZoBillingSummarizeUsageQueryV1 {
|
|
1104
|
+
/**
|
|
1105
|
+
* Rows per page, at most 200; a larger value is reduced to it.
|
|
1106
|
+
*/
|
|
1107
|
+
limit?: number;
|
|
1108
|
+
/**
|
|
1109
|
+
* The previous page's next_cursor, sent with the same sort, filter and search.
|
|
1110
|
+
*/
|
|
1111
|
+
cursor?: string;
|
|
1112
|
+
sort?: "key.asc";
|
|
1113
|
+
filter?: {
|
|
1114
|
+
product?: (string | null);
|
|
1115
|
+
meter?: (string | null);
|
|
1116
|
+
model_id?: (string | null);
|
|
1117
|
+
resource_id?: (string | null);
|
|
1118
|
+
agent_id?: (string | null);
|
|
1119
|
+
agent_session_id?: (string | null);
|
|
1120
|
+
turn_id?: (string | null);
|
|
1121
|
+
usage_id?: (string | null);
|
|
1122
|
+
};
|
|
1123
|
+
}
|
|
750
1124
|
export interface ZoConnectionAuthorizeInputV1 {
|
|
751
1125
|
connection_id: string;
|
|
752
1126
|
expected_revision: number;
|
|
@@ -788,19 +1162,54 @@ export interface ZoConnectionAuthorizeOutputV1KeyAttached {
|
|
|
788
1162
|
revision: number;
|
|
789
1163
|
}
|
|
790
1164
|
export interface ZoConnectionCreateInputV1 {
|
|
1165
|
+
/**
|
|
1166
|
+
* @maxItems 100
|
|
1167
|
+
*
|
|
1168
|
+
* Items: A tag ID or name; unknown names are created, unknown IDs are refused.
|
|
1169
|
+
*/
|
|
1170
|
+
tags?: string[];
|
|
791
1171
|
workspace_id: string;
|
|
792
|
-
|
|
793
|
-
|
|
1172
|
+
/**
|
|
1173
|
+
* The published definition to connect to. Give it, or `values`, not both.
|
|
1174
|
+
*/
|
|
1175
|
+
definition_id?: (string | null);
|
|
1176
|
+
/**
|
|
1177
|
+
* The version of `definition_id` to connect to; required with it.
|
|
1178
|
+
*/
|
|
1179
|
+
definition_version?: (number | null);
|
|
794
1180
|
display_name: string;
|
|
795
|
-
|
|
1181
|
+
/**
|
|
1182
|
+
* Describe what this connection is for in the user's terms.
|
|
1183
|
+
*/
|
|
1184
|
+
description?: string;
|
|
1185
|
+
/**
|
|
1186
|
+
* The connection's configuration; required with `definition_id`.
|
|
1187
|
+
*/
|
|
1188
|
+
configuration?: ({
|
|
796
1189
|
[k: string]: JsonValue;
|
|
797
|
-
};
|
|
1190
|
+
} | null);
|
|
798
1191
|
visibility?: ("workspace" | "protected");
|
|
1192
|
+
/**
|
|
1193
|
+
* Named values to store, in place of a definition: Zo publishes a private definition named after `display_name`, with one required key credential per name delivered as the environment variable of that name, creates the connection and stores every value. A definition name already taken in the workspace returns `conflict`. A name Zo refuses as an environment variable returns `invalid_input` with the `invalid_environment` violation.
|
|
1194
|
+
*/
|
|
1195
|
+
values?: ({
|
|
1196
|
+
/**
|
|
1197
|
+
* Secret: the value. Stored sealed and never returned.
|
|
1198
|
+
*/
|
|
1199
|
+
[k: string]: string;
|
|
1200
|
+
} | null);
|
|
1201
|
+
/**
|
|
1202
|
+
* Environment variables delivered, exactly as written, to machines that list this connection, beside its credential and the variables its definition sets. Plain strings, not secrets: put a secret in the vault. Names are upper-case letters, digits and underscores; at most 64 variables of at most 4096 characters each.
|
|
1203
|
+
*/
|
|
1204
|
+
environment?: {
|
|
1205
|
+
[k: string]: string;
|
|
1206
|
+
};
|
|
799
1207
|
}
|
|
800
1208
|
export interface ZoConnectionCreateOutputV1 {
|
|
801
1209
|
id: string;
|
|
802
1210
|
workspace_id: string;
|
|
803
1211
|
display_name: string;
|
|
1212
|
+
description: string;
|
|
804
1213
|
definition_id: string;
|
|
805
1214
|
definition_version: number;
|
|
806
1215
|
visibility: ("workspace" | "protected");
|
|
@@ -824,6 +1233,7 @@ export interface ZoConnectionDisconnectOutputV1 {
|
|
|
824
1233
|
id: string;
|
|
825
1234
|
workspace_id: string;
|
|
826
1235
|
display_name: string;
|
|
1236
|
+
description: string;
|
|
827
1237
|
definition_id: string;
|
|
828
1238
|
definition_version: number;
|
|
829
1239
|
visibility: ("workspace" | "protected");
|
|
@@ -838,6 +1248,7 @@ export interface ZoConnectionGetOutputV1 {
|
|
|
838
1248
|
id: string;
|
|
839
1249
|
workspace_id: string;
|
|
840
1250
|
display_name: string;
|
|
1251
|
+
description: string;
|
|
841
1252
|
definition_id: string;
|
|
842
1253
|
definition_version: number;
|
|
843
1254
|
visibility: ("workspace" | "protected");
|
|
@@ -847,6 +1258,9 @@ export interface ZoConnectionGetOutputV1 {
|
|
|
847
1258
|
account_labels: {
|
|
848
1259
|
[k: string]: string;
|
|
849
1260
|
};
|
|
1261
|
+
environment: {
|
|
1262
|
+
[k: string]: string;
|
|
1263
|
+
};
|
|
850
1264
|
}
|
|
851
1265
|
export interface ZoConnectionListInputV1 {
|
|
852
1266
|
workspace_id: string;
|
|
@@ -859,6 +1273,7 @@ export interface ZoConnectionListOutputV1ConnectionWithAccountsResource {
|
|
|
859
1273
|
id: string;
|
|
860
1274
|
workspace_id: string;
|
|
861
1275
|
display_name: string;
|
|
1276
|
+
description: string;
|
|
862
1277
|
definition_id: string;
|
|
863
1278
|
definition_version: number;
|
|
864
1279
|
visibility: ("workspace" | "protected");
|
|
@@ -868,6 +1283,9 @@ export interface ZoConnectionListOutputV1ConnectionWithAccountsResource {
|
|
|
868
1283
|
account_labels: {
|
|
869
1284
|
[k: string]: string;
|
|
870
1285
|
};
|
|
1286
|
+
environment: {
|
|
1287
|
+
[k: string]: string;
|
|
1288
|
+
};
|
|
871
1289
|
}
|
|
872
1290
|
export interface ZoConnectionListQueryV1 {
|
|
873
1291
|
/**
|
|
@@ -904,6 +1322,7 @@ export interface ZoConnectionSlackCompleteAuthorizationOutputV1 {
|
|
|
904
1322
|
id: string;
|
|
905
1323
|
workspace_id: string;
|
|
906
1324
|
display_name: string;
|
|
1325
|
+
description: string;
|
|
907
1326
|
definition_id: string;
|
|
908
1327
|
definition_version: number;
|
|
909
1328
|
visibility: ("workspace" | "protected");
|
|
@@ -913,6 +1332,9 @@ export interface ZoConnectionSlackCompleteAuthorizationOutputV1 {
|
|
|
913
1332
|
account_labels: {
|
|
914
1333
|
[k: string]: string;
|
|
915
1334
|
};
|
|
1335
|
+
environment: {
|
|
1336
|
+
[k: string]: string;
|
|
1337
|
+
};
|
|
916
1338
|
}
|
|
917
1339
|
export interface ZoConnectionSlackStartAuthorizationInputV1 {
|
|
918
1340
|
connection_id: string;
|
|
@@ -936,11 +1358,32 @@ export interface ZoConnectionUpdateInputV1 {
|
|
|
936
1358
|
* A new name for the connection; omit it to keep the current name.
|
|
937
1359
|
*/
|
|
938
1360
|
display_name?: (string | null);
|
|
1361
|
+
/**
|
|
1362
|
+
* Describe what this connection is for in the user's terms.
|
|
1363
|
+
*/
|
|
1364
|
+
description?: (string | null);
|
|
1365
|
+
/**
|
|
1366
|
+
* Move the connection to this version of its definition, keeping its id and grants. Credentials in both versions keep their values, credentials only the current version has are erased, and credentials only the new version has start empty. Omit it to stay on the current version.
|
|
1367
|
+
*/
|
|
1368
|
+
definition_version?: (number | null);
|
|
1369
|
+
/**
|
|
1370
|
+
* Named values to set, or `null` to remove a name, on a connection whose definition is private to its workspace and holds only single-value key credentials, as one created from `values` does. Changing a value replaces that credential. Adding or removing a name publishes the definition's next version from the connection's own version and moves the connection to it, keeping its id and grants; other connections to the definition stay on their versions. A connection keeps at least one name. Any other connection returns `invalid_input`.
|
|
1371
|
+
*/
|
|
1372
|
+
values?: ({
|
|
1373
|
+
[k: string]: string | null;
|
|
1374
|
+
} | null);
|
|
1375
|
+
/**
|
|
1376
|
+
* The environment that replaces the stored one; omit it to keep the stored environment. Environment variables delivered, exactly as written, to machines that list this connection, beside its credential and the variables its definition sets. Plain strings, not secrets: put a secret in the vault. Names are upper-case letters, digits and underscores; at most 64 variables of at most 4096 characters each.
|
|
1377
|
+
*/
|
|
1378
|
+
environment?: ({
|
|
1379
|
+
[k: string]: string;
|
|
1380
|
+
} | null);
|
|
939
1381
|
}
|
|
940
1382
|
export interface ZoConnectionUpdateOutputV1 {
|
|
941
1383
|
id: string;
|
|
942
1384
|
workspace_id: string;
|
|
943
1385
|
display_name: string;
|
|
1386
|
+
description: string;
|
|
944
1387
|
definition_id: string;
|
|
945
1388
|
definition_version: number;
|
|
946
1389
|
visibility: ("workspace" | "protected");
|
|
@@ -1026,6 +1469,12 @@ export interface ZoConnectionDefinitionPublishOutputV1 {
|
|
|
1026
1469
|
visibility: string;
|
|
1027
1470
|
}
|
|
1028
1471
|
export interface ZoDatabaseCreateInputV1 {
|
|
1472
|
+
/**
|
|
1473
|
+
* @maxItems 100
|
|
1474
|
+
*
|
|
1475
|
+
* Items: A tag ID or name; unknown names are created, unknown IDs are refused.
|
|
1476
|
+
*/
|
|
1477
|
+
tags?: string[];
|
|
1029
1478
|
workspace_id: string;
|
|
1030
1479
|
/**
|
|
1031
1480
|
* Required but ignored: a retried create can make a second database.
|
|
@@ -1738,6 +2187,12 @@ export interface ZoDatabaseUpdateOutputV1DatabaseStorage {
|
|
|
1738
2187
|
* ``subject_type`` is the resource type an occurrence's ``subject`` names.
|
|
1739
2188
|
*/
|
|
1740
2189
|
export interface ZoEventCreateInputV1 {
|
|
2190
|
+
/**
|
|
2191
|
+
* @maxItems 100
|
|
2192
|
+
*
|
|
2193
|
+
* Items: A tag ID or name; unknown names are created, unknown IDs are refused.
|
|
2194
|
+
*/
|
|
2195
|
+
tags?: string[];
|
|
1741
2196
|
workspace_id: string;
|
|
1742
2197
|
publisher: string;
|
|
1743
2198
|
name: string;
|
|
@@ -1790,6 +2245,12 @@ export interface ZoEventCreateOutputV1EventProperties {
|
|
|
1790
2245
|
* to, which ``per_conversation`` Agent subscriptions key sessions by.
|
|
1791
2246
|
*/
|
|
1792
2247
|
export interface ZoEventCreateInputV2 {
|
|
2248
|
+
/**
|
|
2249
|
+
* @maxItems 100
|
|
2250
|
+
*
|
|
2251
|
+
* Items: A tag ID or name; unknown names are created, unknown IDs are refused.
|
|
2252
|
+
*/
|
|
2253
|
+
tags?: string[];
|
|
1793
2254
|
workspace_id: string;
|
|
1794
2255
|
publisher: string;
|
|
1795
2256
|
name: string;
|
|
@@ -2127,6 +2588,10 @@ export interface ZoFunctionCancelRunOutputV1 {
|
|
|
2127
2588
|
export interface ZoFunctionCreateInputV1 {
|
|
2128
2589
|
workspace_id: string;
|
|
2129
2590
|
display_name: string;
|
|
2591
|
+
/**
|
|
2592
|
+
* Describe what this function is for in the user's terms.
|
|
2593
|
+
*/
|
|
2594
|
+
description?: string;
|
|
2130
2595
|
visibility?: ("workspace" | "protected");
|
|
2131
2596
|
}
|
|
2132
2597
|
export interface ZoFunctionCreateOutputV1 {
|
|
@@ -2135,6 +2600,7 @@ export interface ZoFunctionCreateOutputV1 {
|
|
|
2135
2600
|
type: "function";
|
|
2136
2601
|
type_version: number;
|
|
2137
2602
|
display_name: string;
|
|
2603
|
+
description: string;
|
|
2138
2604
|
revision: number;
|
|
2139
2605
|
properties: ZoFunctionCreateOutputV1FunctionProperties;
|
|
2140
2606
|
active_deployment_id: (string | null);
|
|
@@ -2203,6 +2669,7 @@ export interface ZoFunctionGetOutputV1 {
|
|
|
2203
2669
|
type: "function";
|
|
2204
2670
|
type_version: number;
|
|
2205
2671
|
display_name: string;
|
|
2672
|
+
description: string;
|
|
2206
2673
|
revision: number;
|
|
2207
2674
|
properties: ZoFunctionGetOutputV1FunctionProperties;
|
|
2208
2675
|
active_deployment_id: (string | null);
|
|
@@ -2323,6 +2790,7 @@ export interface ZoFunctionListOutputV1VisibleFunctionResource {
|
|
|
2323
2790
|
type: "function";
|
|
2324
2791
|
type_version: number;
|
|
2325
2792
|
display_name: string;
|
|
2793
|
+
description: string;
|
|
2326
2794
|
revision: number;
|
|
2327
2795
|
properties: ZoFunctionListOutputV1FunctionProperties;
|
|
2328
2796
|
active_deployment_id: (string | null);
|
|
@@ -2385,6 +2853,34 @@ export interface ZoFunctionPublishContractOutputV1 {
|
|
|
2385
2853
|
contract_version: number;
|
|
2386
2854
|
digest: string;
|
|
2387
2855
|
}
|
|
2856
|
+
/**
|
|
2857
|
+
* Omitted fields keep their value.
|
|
2858
|
+
*/
|
|
2859
|
+
export interface ZoFunctionUpdateInputV1 {
|
|
2860
|
+
function_id: string;
|
|
2861
|
+
expected_revision: number;
|
|
2862
|
+
display_name?: (string | null);
|
|
2863
|
+
/**
|
|
2864
|
+
* "" clears the description.
|
|
2865
|
+
*/
|
|
2866
|
+
description?: (string | null);
|
|
2867
|
+
}
|
|
2868
|
+
export interface ZoFunctionUpdateOutputV1 {
|
|
2869
|
+
id: string;
|
|
2870
|
+
workspace_id: string;
|
|
2871
|
+
type: "function";
|
|
2872
|
+
type_version: number;
|
|
2873
|
+
display_name: string;
|
|
2874
|
+
description: string;
|
|
2875
|
+
revision: number;
|
|
2876
|
+
properties: ZoFunctionUpdateOutputV1FunctionProperties;
|
|
2877
|
+
active_deployment_id: (string | null);
|
|
2878
|
+
visibility: ("workspace" | "protected");
|
|
2879
|
+
owner_user_id: (string | null);
|
|
2880
|
+
}
|
|
2881
|
+
export interface ZoFunctionUpdateOutputV1FunctionProperties {
|
|
2882
|
+
code_owner: ("zo" | "workspace");
|
|
2883
|
+
}
|
|
2388
2884
|
export interface ZoMachineApplyPatchInputV1 {
|
|
2389
2885
|
machine_id: string;
|
|
2390
2886
|
path: string;
|
|
@@ -2406,22 +2902,51 @@ export interface ZoMachineApplyPatchOutputV1 {
|
|
|
2406
2902
|
size: number;
|
|
2407
2903
|
sha256: string;
|
|
2408
2904
|
}
|
|
2905
|
+
export type ZoMachineCreateInputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2409
2906
|
export interface ZoMachineCreateInputV1 {
|
|
2907
|
+
/**
|
|
2908
|
+
* @maxItems 100
|
|
2909
|
+
*
|
|
2910
|
+
* Items: A tag ID or name; unknown names are created, unknown IDs are refused.
|
|
2911
|
+
*/
|
|
2912
|
+
tags?: string[];
|
|
2410
2913
|
workspace_id: string;
|
|
2411
2914
|
idempotency_key: string;
|
|
2412
2915
|
display_name: string;
|
|
2916
|
+
/**
|
|
2917
|
+
* Describe what this machine is for in the user's terms.
|
|
2918
|
+
*/
|
|
2919
|
+
description?: string;
|
|
2413
2920
|
source: ZoMachineCreateInputV1MachineSourceInput;
|
|
2414
2921
|
resources: ZoMachineCreateInputV1MachineResourcesInput;
|
|
2415
2922
|
lifecycle: ZoMachineCreateInputV1MachineLifecycleInput;
|
|
2416
2923
|
region?: string;
|
|
2417
2924
|
/**
|
|
2418
|
-
* Which process runs first at boot. `none` (default): nothing; the machine waits for exec. `image`: the init system inside the machine's image (systemd, OpenRC) becomes PID 1 and starts the services enabled on its disk. This does not choose the image; `source.machine_image_id` does. Debian and Ubuntu images need `systemd systemd-sysv` installed first. A unit restarts after a crash only when it sets `Restart=`.
|
|
2925
|
+
* Which process runs first at boot. `none` (default): nothing; the machine waits for exec. `image`: the init system inside the machine's image (systemd, OpenRC) becomes PID 1 and starts the services enabled on its disk. This does not choose the image; `source.machine_image_id` does. Debian and Ubuntu images need `systemd systemd-sysv` installed first. A unit restarts after a crash only when it sets `Restart=`. GPU machines require `none`.
|
|
2419
2926
|
*/
|
|
2420
2927
|
init?: ("none" | "image");
|
|
2421
2928
|
/**
|
|
2422
|
-
* Run these arguments as the main process on every boot, without a shell. Use ["sh", "-c", ...] for shell syntax. Find ENTRYPOINT and CMD on the image's registry page; Zo does not return them. Pass ENTRYPOINT then CMD. With `init: image`, the command must wait for services it needs. The machine stops when it exits; resume runs it again. It may run more than once after a lost create or resume response, so make it safe to rerun. Each argument is at most 4,096 UTF-8 bytes and all arguments total at most 65,536 bytes. A running command is not activity: set `idle_timeout_seconds` at least as long as the job. The maximum is published by `zo.machine.list_configurations
|
|
2929
|
+
* Run these arguments as the main process on every boot, without a shell. Use ["sh", "-c", ...] for shell syntax. Find ENTRYPOINT and CMD on the image's registry page; Zo does not return them. Pass ENTRYPOINT then CMD. With `init: image`, the command must wait for services it needs. The machine stops when it exits; resume runs it again. It may run more than once after a lost create or resume response, so make it safe to rerun. Each argument is at most 4,096 UTF-8 bytes and all arguments total at most 65,536 bytes. A running command is not activity: set `idle_timeout_seconds` at least as long as the job. The maximum is published by `zo.machine.list_configurations`: 3,600 s for CPU machines and 86,400 s for GPU machines. Longer CPU jobs need Zo exec or file calls, or HTTP through a tunnel or connect token. After exit, `get` may show `running` for a few minutes until the stop is recorded. Zo reports no exit reason or code. Write a job's result to disk. A resume runs the command again, so to read it, clear the command, resume, then use `zo.machine.read_bytes`. With `init: image` and a command, a missing `/sbin/init` ends the generation as an exit stop, without `incompatible_image`.
|
|
2423
2930
|
*/
|
|
2424
2931
|
command?: ([string, ...(string)[]] | null);
|
|
2932
|
+
/**
|
|
2933
|
+
* Environment variables set, exactly as written, in the boot process and every command run on the machine. Plain strings, not secrets: they are part of the machine's configuration, which anyone who can read the machine sees. Names are upper-case letters, digits and underscores, and reserved names such as `PATH` or ones starting with `ZO_` are refused; at most 64 variables of at most 4096 characters each. A variable here wins over a connection in `credentials` that sets the same name.
|
|
2934
|
+
*/
|
|
2935
|
+
environment?: {
|
|
2936
|
+
[k: string]: string;
|
|
2937
|
+
};
|
|
2938
|
+
/**
|
|
2939
|
+
* Connection IDs whose credentials the machine receives as environment variables, in the boot process and every command. Each slot of a listed connection sets the variable its definition names, with the variables the slot and the connection declare. The machine also needs a use grant on each connection (`zo.grant.create` with the machine as assignee); a listed connection without one delivers nothing. When two listed connections set the same variable, the later one in the list wins. At most 100 connections, each listed once.
|
|
2940
|
+
*
|
|
2941
|
+
* @maxItems 100
|
|
2942
|
+
*/
|
|
2943
|
+
credentials?: string[];
|
|
2944
|
+
/**
|
|
2945
|
+
* Header rules: on HTTPS requests from the machine to a rule's hosts, Zo sets a header built from a connection's credential, and the credential never enters the machine. A rule names the connection (`credential`) and one of its definition's slots (`slot`). With only those two, it uses the hosts, header and format the slot declares in its `injections`. It may give its own `hosts`, `location` and `format`, all three together, only for a slot that declares an `environment_variable`. Formats: `bearer` (`Bearer <value>`), `basic` with a `username` (`Basic` with base64 of `<username>:<value>`) and `raw` (the value as stored). A rule sets its header only while the machine holds a use grant on the connection. Two rules can't set the same header on the same host, and all rules together set at most 25 header values. Requests to a host with a rule use HTTP/1.1.
|
|
2946
|
+
*
|
|
2947
|
+
* @maxItems 25
|
|
2948
|
+
*/
|
|
2949
|
+
outbound_network_policies?: ZoMachineCreateInputV1OutboundNetworkPolicy[];
|
|
2425
2950
|
/**
|
|
2426
2951
|
* `workspace` (default): every member can see and use it. `protected`: only you, and whoever you share it with; workspace-wide grants don't reach it. Fixed at creation.
|
|
2427
2952
|
*/
|
|
@@ -2439,11 +2964,62 @@ export interface ZoMachineCreateInputV1MachineResourcesInput {
|
|
|
2439
2964
|
*/
|
|
2440
2965
|
vcpus: number;
|
|
2441
2966
|
memory_mib: number;
|
|
2967
|
+
gpu?: (ZoMachineCreateInputV1MachineGpu | null);
|
|
2968
|
+
}
|
|
2969
|
+
export interface ZoMachineCreateInputV1MachineGpu {
|
|
2970
|
+
type: ZoMachineCreateInputV1GpuType;
|
|
2971
|
+
count: number;
|
|
2442
2972
|
}
|
|
2443
2973
|
export interface ZoMachineCreateInputV1MachineLifecycleInput {
|
|
2444
|
-
|
|
2974
|
+
/**
|
|
2975
|
+
* Omit for 900 seconds on CPU. For GPU, the default is the smaller of 300 seconds and max_run_seconds. An explicit GPU idle timeout must not exceed max_run_seconds.
|
|
2976
|
+
*/
|
|
2977
|
+
idle_timeout_seconds?: (number | null);
|
|
2445
2978
|
max_run_seconds: number;
|
|
2446
2979
|
}
|
|
2980
|
+
/**
|
|
2981
|
+
* Send one slot's credential as a header on HTTPS requests to some hosts.
|
|
2982
|
+
*/
|
|
2983
|
+
export interface ZoMachineCreateInputV1OutboundNetworkPolicy {
|
|
2984
|
+
/**
|
|
2985
|
+
* The connection ID.
|
|
2986
|
+
*/
|
|
2987
|
+
credential: string;
|
|
2988
|
+
/**
|
|
2989
|
+
* The connection definition's slot, by name.
|
|
2990
|
+
*/
|
|
2991
|
+
slot: string;
|
|
2992
|
+
hosts?: ([string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | null);
|
|
2993
|
+
location?: (ZoMachineCreateInputV1HeaderLocation | null);
|
|
2994
|
+
format?: ((ZoMachineCreateInputV1BearerFormat | ZoMachineCreateInputV1BasicFormat | ZoMachineCreateInputV1RawFormat) | null);
|
|
2995
|
+
}
|
|
2996
|
+
export interface ZoMachineCreateInputV1HeaderLocation {
|
|
2997
|
+
type: "header";
|
|
2998
|
+
/**
|
|
2999
|
+
* The header to set, such as `Authorization` or `X-API-Key`.
|
|
3000
|
+
*/
|
|
3001
|
+
name: string;
|
|
3002
|
+
}
|
|
3003
|
+
export interface ZoMachineCreateInputV1BearerFormat {
|
|
3004
|
+
/**
|
|
3005
|
+
* `Bearer <value>`.
|
|
3006
|
+
*/
|
|
3007
|
+
type: "bearer";
|
|
3008
|
+
}
|
|
3009
|
+
export interface ZoMachineCreateInputV1BasicFormat {
|
|
3010
|
+
/**
|
|
3011
|
+
* `Basic` with base64 of `<username>:<value>`.
|
|
3012
|
+
*/
|
|
3013
|
+
type: "basic";
|
|
3014
|
+
username: string;
|
|
3015
|
+
}
|
|
3016
|
+
export interface ZoMachineCreateInputV1RawFormat {
|
|
3017
|
+
/**
|
|
3018
|
+
* The value as it is.
|
|
3019
|
+
*/
|
|
3020
|
+
type: "raw";
|
|
3021
|
+
}
|
|
3022
|
+
export type ZoMachineCreateOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2447
3023
|
export type ZoMachineCreateOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2448
3024
|
/**
|
|
2449
3025
|
* A machine's registry envelope, boot settings and row-owned lifecycle state.
|
|
@@ -2454,6 +3030,7 @@ export interface ZoMachineCreateOutputV1 {
|
|
|
2454
3030
|
type: "machine";
|
|
2455
3031
|
type_version: 1;
|
|
2456
3032
|
display_name: string;
|
|
3033
|
+
description: string;
|
|
2457
3034
|
visibility: ("workspace" | "protected");
|
|
2458
3035
|
revision: number;
|
|
2459
3036
|
properties: ZoMachineCreateOutputV1MachineProperties;
|
|
@@ -2465,6 +3042,8 @@ export interface ZoMachineCreateOutputV1 {
|
|
|
2465
3042
|
created_at: string;
|
|
2466
3043
|
updated_at: string;
|
|
2467
3044
|
destroyed_at: (string | null);
|
|
3045
|
+
recoverable_until?: (string | null);
|
|
3046
|
+
recovery_acceptance_required?: boolean;
|
|
2468
3047
|
}
|
|
2469
3048
|
/**
|
|
2470
3049
|
* Public properties of a `machine` resource.
|
|
@@ -2483,11 +3062,63 @@ export interface ZoMachineCreateOutputV1MachineProperties {
|
|
|
2483
3062
|
machine_image_id: (string | null);
|
|
2484
3063
|
vcpus: (number | null);
|
|
2485
3064
|
memory_mib: (number | null);
|
|
3065
|
+
gpu?: (ZoMachineCreateOutputV1MachineGpu | null);
|
|
2486
3066
|
region: (string | null);
|
|
2487
3067
|
idle_timeout_seconds: (number | null);
|
|
2488
3068
|
max_run_seconds: (number | null);
|
|
2489
3069
|
init?: (("none" | "image") | null);
|
|
2490
3070
|
command?: ([string, ...(string)[]] | null);
|
|
3071
|
+
environment?: ({
|
|
3072
|
+
[k: string]: string;
|
|
3073
|
+
} | null);
|
|
3074
|
+
credentials?: (string[] | null);
|
|
3075
|
+
outbound_network_policies?: (ZoMachineCreateOutputV1OutboundNetworkPolicy[] | null);
|
|
3076
|
+
}
|
|
3077
|
+
export interface ZoMachineCreateOutputV1MachineGpu {
|
|
3078
|
+
type: ZoMachineCreateOutputV1GpuType;
|
|
3079
|
+
count: number;
|
|
3080
|
+
}
|
|
3081
|
+
/**
|
|
3082
|
+
* Send one slot's credential as a header on HTTPS requests to some hosts.
|
|
3083
|
+
*/
|
|
3084
|
+
export interface ZoMachineCreateOutputV1OutboundNetworkPolicy {
|
|
3085
|
+
/**
|
|
3086
|
+
* The connection ID.
|
|
3087
|
+
*/
|
|
3088
|
+
credential: string;
|
|
3089
|
+
/**
|
|
3090
|
+
* The connection definition's slot, by name.
|
|
3091
|
+
*/
|
|
3092
|
+
slot: string;
|
|
3093
|
+
hosts?: ([string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | null);
|
|
3094
|
+
location?: (ZoMachineCreateOutputV1HeaderLocation | null);
|
|
3095
|
+
format?: ((ZoMachineCreateOutputV1BearerFormat | ZoMachineCreateOutputV1BasicFormat | ZoMachineCreateOutputV1RawFormat) | null);
|
|
3096
|
+
}
|
|
3097
|
+
export interface ZoMachineCreateOutputV1HeaderLocation {
|
|
3098
|
+
type: "header";
|
|
3099
|
+
/**
|
|
3100
|
+
* The header to set, such as `Authorization` or `X-API-Key`.
|
|
3101
|
+
*/
|
|
3102
|
+
name: string;
|
|
3103
|
+
}
|
|
3104
|
+
export interface ZoMachineCreateOutputV1BearerFormat {
|
|
3105
|
+
/**
|
|
3106
|
+
* `Bearer <value>`.
|
|
3107
|
+
*/
|
|
3108
|
+
type: "bearer";
|
|
3109
|
+
}
|
|
3110
|
+
export interface ZoMachineCreateOutputV1BasicFormat {
|
|
3111
|
+
/**
|
|
3112
|
+
* `Basic` with base64 of `<username>:<value>`.
|
|
3113
|
+
*/
|
|
3114
|
+
type: "basic";
|
|
3115
|
+
username: string;
|
|
3116
|
+
}
|
|
3117
|
+
export interface ZoMachineCreateOutputV1RawFormat {
|
|
3118
|
+
/**
|
|
3119
|
+
* The value as it is.
|
|
3120
|
+
*/
|
|
3121
|
+
type: "raw";
|
|
2491
3122
|
}
|
|
2492
3123
|
export interface ZoMachineCreateOutputV1MachineBootedView {
|
|
2493
3124
|
init: ("none" | "image");
|
|
@@ -2498,6 +3129,7 @@ export interface ZoMachineDestroyInputV1 {
|
|
|
2498
3129
|
expected_revision: number;
|
|
2499
3130
|
idempotency_key: string;
|
|
2500
3131
|
}
|
|
3132
|
+
export type ZoMachineDestroyOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2501
3133
|
export type ZoMachineDestroyOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2502
3134
|
/**
|
|
2503
3135
|
* A machine's registry envelope, boot settings and row-owned lifecycle state.
|
|
@@ -2508,6 +3140,7 @@ export interface ZoMachineDestroyOutputV1 {
|
|
|
2508
3140
|
type: "machine";
|
|
2509
3141
|
type_version: 1;
|
|
2510
3142
|
display_name: string;
|
|
3143
|
+
description: string;
|
|
2511
3144
|
visibility: ("workspace" | "protected");
|
|
2512
3145
|
revision: number;
|
|
2513
3146
|
properties: ZoMachineDestroyOutputV1MachineProperties;
|
|
@@ -2519,6 +3152,8 @@ export interface ZoMachineDestroyOutputV1 {
|
|
|
2519
3152
|
created_at: string;
|
|
2520
3153
|
updated_at: string;
|
|
2521
3154
|
destroyed_at: (string | null);
|
|
3155
|
+
recoverable_until?: (string | null);
|
|
3156
|
+
recovery_acceptance_required?: boolean;
|
|
2522
3157
|
}
|
|
2523
3158
|
/**
|
|
2524
3159
|
* Public properties of a `machine` resource.
|
|
@@ -2537,11 +3172,63 @@ export interface ZoMachineDestroyOutputV1MachineProperties {
|
|
|
2537
3172
|
machine_image_id: (string | null);
|
|
2538
3173
|
vcpus: (number | null);
|
|
2539
3174
|
memory_mib: (number | null);
|
|
3175
|
+
gpu?: (ZoMachineDestroyOutputV1MachineGpu | null);
|
|
2540
3176
|
region: (string | null);
|
|
2541
3177
|
idle_timeout_seconds: (number | null);
|
|
2542
3178
|
max_run_seconds: (number | null);
|
|
2543
3179
|
init?: (("none" | "image") | null);
|
|
2544
3180
|
command?: ([string, ...(string)[]] | null);
|
|
3181
|
+
environment?: ({
|
|
3182
|
+
[k: string]: string;
|
|
3183
|
+
} | null);
|
|
3184
|
+
credentials?: (string[] | null);
|
|
3185
|
+
outbound_network_policies?: (ZoMachineDestroyOutputV1OutboundNetworkPolicy[] | null);
|
|
3186
|
+
}
|
|
3187
|
+
export interface ZoMachineDestroyOutputV1MachineGpu {
|
|
3188
|
+
type: ZoMachineDestroyOutputV1GpuType;
|
|
3189
|
+
count: number;
|
|
3190
|
+
}
|
|
3191
|
+
/**
|
|
3192
|
+
* Send one slot's credential as a header on HTTPS requests to some hosts.
|
|
3193
|
+
*/
|
|
3194
|
+
export interface ZoMachineDestroyOutputV1OutboundNetworkPolicy {
|
|
3195
|
+
/**
|
|
3196
|
+
* The connection ID.
|
|
3197
|
+
*/
|
|
3198
|
+
credential: string;
|
|
3199
|
+
/**
|
|
3200
|
+
* The connection definition's slot, by name.
|
|
3201
|
+
*/
|
|
3202
|
+
slot: string;
|
|
3203
|
+
hosts?: ([string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | null);
|
|
3204
|
+
location?: (ZoMachineDestroyOutputV1HeaderLocation | null);
|
|
3205
|
+
format?: ((ZoMachineDestroyOutputV1BearerFormat | ZoMachineDestroyOutputV1BasicFormat | ZoMachineDestroyOutputV1RawFormat) | null);
|
|
3206
|
+
}
|
|
3207
|
+
export interface ZoMachineDestroyOutputV1HeaderLocation {
|
|
3208
|
+
type: "header";
|
|
3209
|
+
/**
|
|
3210
|
+
* The header to set, such as `Authorization` or `X-API-Key`.
|
|
3211
|
+
*/
|
|
3212
|
+
name: string;
|
|
3213
|
+
}
|
|
3214
|
+
export interface ZoMachineDestroyOutputV1BearerFormat {
|
|
3215
|
+
/**
|
|
3216
|
+
* `Bearer <value>`.
|
|
3217
|
+
*/
|
|
3218
|
+
type: "bearer";
|
|
3219
|
+
}
|
|
3220
|
+
export interface ZoMachineDestroyOutputV1BasicFormat {
|
|
3221
|
+
/**
|
|
3222
|
+
* `Basic` with base64 of `<username>:<value>`.
|
|
3223
|
+
*/
|
|
3224
|
+
type: "basic";
|
|
3225
|
+
username: string;
|
|
3226
|
+
}
|
|
3227
|
+
export interface ZoMachineDestroyOutputV1RawFormat {
|
|
3228
|
+
/**
|
|
3229
|
+
* The value as it is.
|
|
3230
|
+
*/
|
|
3231
|
+
type: "raw";
|
|
2545
3232
|
}
|
|
2546
3233
|
export interface ZoMachineDestroyOutputV1MachineBootedView {
|
|
2547
3234
|
init: ("none" | "image");
|
|
@@ -2565,6 +3252,7 @@ export interface ZoMachineExecOutputV1 {
|
|
|
2565
3252
|
export interface ZoMachineGetInputV1 {
|
|
2566
3253
|
machine_id: string;
|
|
2567
3254
|
}
|
|
3255
|
+
export type ZoMachineGetOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2568
3256
|
export type ZoMachineGetOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2569
3257
|
/**
|
|
2570
3258
|
* A machine's registry envelope, boot settings and row-owned lifecycle state.
|
|
@@ -2575,6 +3263,7 @@ export interface ZoMachineGetOutputV1 {
|
|
|
2575
3263
|
type: "machine";
|
|
2576
3264
|
type_version: 1;
|
|
2577
3265
|
display_name: string;
|
|
3266
|
+
description: string;
|
|
2578
3267
|
visibility: ("workspace" | "protected");
|
|
2579
3268
|
revision: number;
|
|
2580
3269
|
properties: ZoMachineGetOutputV1MachineProperties;
|
|
@@ -2586,6 +3275,8 @@ export interface ZoMachineGetOutputV1 {
|
|
|
2586
3275
|
created_at: string;
|
|
2587
3276
|
updated_at: string;
|
|
2588
3277
|
destroyed_at: (string | null);
|
|
3278
|
+
recoverable_until?: (string | null);
|
|
3279
|
+
recovery_acceptance_required?: boolean;
|
|
2589
3280
|
}
|
|
2590
3281
|
/**
|
|
2591
3282
|
* Public properties of a `machine` resource.
|
|
@@ -2604,11 +3295,63 @@ export interface ZoMachineGetOutputV1MachineProperties {
|
|
|
2604
3295
|
machine_image_id: (string | null);
|
|
2605
3296
|
vcpus: (number | null);
|
|
2606
3297
|
memory_mib: (number | null);
|
|
3298
|
+
gpu?: (ZoMachineGetOutputV1MachineGpu | null);
|
|
2607
3299
|
region: (string | null);
|
|
2608
3300
|
idle_timeout_seconds: (number | null);
|
|
2609
3301
|
max_run_seconds: (number | null);
|
|
2610
3302
|
init?: (("none" | "image") | null);
|
|
2611
3303
|
command?: ([string, ...(string)[]] | null);
|
|
3304
|
+
environment?: ({
|
|
3305
|
+
[k: string]: string;
|
|
3306
|
+
} | null);
|
|
3307
|
+
credentials?: (string[] | null);
|
|
3308
|
+
outbound_network_policies?: (ZoMachineGetOutputV1OutboundNetworkPolicy[] | null);
|
|
3309
|
+
}
|
|
3310
|
+
export interface ZoMachineGetOutputV1MachineGpu {
|
|
3311
|
+
type: ZoMachineGetOutputV1GpuType;
|
|
3312
|
+
count: number;
|
|
3313
|
+
}
|
|
3314
|
+
/**
|
|
3315
|
+
* Send one slot's credential as a header on HTTPS requests to some hosts.
|
|
3316
|
+
*/
|
|
3317
|
+
export interface ZoMachineGetOutputV1OutboundNetworkPolicy {
|
|
3318
|
+
/**
|
|
3319
|
+
* The connection ID.
|
|
3320
|
+
*/
|
|
3321
|
+
credential: string;
|
|
3322
|
+
/**
|
|
3323
|
+
* The connection definition's slot, by name.
|
|
3324
|
+
*/
|
|
3325
|
+
slot: string;
|
|
3326
|
+
hosts?: ([string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | null);
|
|
3327
|
+
location?: (ZoMachineGetOutputV1HeaderLocation | null);
|
|
3328
|
+
format?: ((ZoMachineGetOutputV1BearerFormat | ZoMachineGetOutputV1BasicFormat | ZoMachineGetOutputV1RawFormat) | null);
|
|
3329
|
+
}
|
|
3330
|
+
export interface ZoMachineGetOutputV1HeaderLocation {
|
|
3331
|
+
type: "header";
|
|
3332
|
+
/**
|
|
3333
|
+
* The header to set, such as `Authorization` or `X-API-Key`.
|
|
3334
|
+
*/
|
|
3335
|
+
name: string;
|
|
3336
|
+
}
|
|
3337
|
+
export interface ZoMachineGetOutputV1BearerFormat {
|
|
3338
|
+
/**
|
|
3339
|
+
* `Bearer <value>`.
|
|
3340
|
+
*/
|
|
3341
|
+
type: "bearer";
|
|
3342
|
+
}
|
|
3343
|
+
export interface ZoMachineGetOutputV1BasicFormat {
|
|
3344
|
+
/**
|
|
3345
|
+
* `Basic` with base64 of `<username>:<value>`.
|
|
3346
|
+
*/
|
|
3347
|
+
type: "basic";
|
|
3348
|
+
username: string;
|
|
3349
|
+
}
|
|
3350
|
+
export interface ZoMachineGetOutputV1RawFormat {
|
|
3351
|
+
/**
|
|
3352
|
+
* The value as it is.
|
|
3353
|
+
*/
|
|
3354
|
+
type: "raw";
|
|
2612
3355
|
}
|
|
2613
3356
|
export interface ZoMachineGetOutputV1MachineBootedView {
|
|
2614
3357
|
init: ("none" | "image");
|
|
@@ -2617,6 +3360,7 @@ export interface ZoMachineGetOutputV1MachineBootedView {
|
|
|
2617
3360
|
export interface ZoMachineListInputV1 {
|
|
2618
3361
|
workspace_id: string;
|
|
2619
3362
|
}
|
|
3363
|
+
export type ZoMachineListOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2620
3364
|
export type ZoMachineListOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2621
3365
|
export interface ZoMachineListOutputV1 {
|
|
2622
3366
|
machines: ZoMachineListOutputV1ManagedMachineView[];
|
|
@@ -2631,6 +3375,7 @@ export interface ZoMachineListOutputV1ManagedMachineView {
|
|
|
2631
3375
|
type: "machine";
|
|
2632
3376
|
type_version: 1;
|
|
2633
3377
|
display_name: string;
|
|
3378
|
+
description: string;
|
|
2634
3379
|
visibility: ("workspace" | "protected");
|
|
2635
3380
|
revision: number;
|
|
2636
3381
|
properties: ZoMachineListOutputV1MachineProperties;
|
|
@@ -2642,6 +3387,8 @@ export interface ZoMachineListOutputV1ManagedMachineView {
|
|
|
2642
3387
|
created_at: string;
|
|
2643
3388
|
updated_at: string;
|
|
2644
3389
|
destroyed_at: (string | null);
|
|
3390
|
+
recoverable_until?: (string | null);
|
|
3391
|
+
recovery_acceptance_required?: boolean;
|
|
2645
3392
|
}
|
|
2646
3393
|
/**
|
|
2647
3394
|
* Public properties of a `machine` resource.
|
|
@@ -2660,11 +3407,63 @@ export interface ZoMachineListOutputV1MachineProperties {
|
|
|
2660
3407
|
machine_image_id: (string | null);
|
|
2661
3408
|
vcpus: (number | null);
|
|
2662
3409
|
memory_mib: (number | null);
|
|
3410
|
+
gpu?: (ZoMachineListOutputV1MachineGpu | null);
|
|
2663
3411
|
region: (string | null);
|
|
2664
3412
|
idle_timeout_seconds: (number | null);
|
|
2665
3413
|
max_run_seconds: (number | null);
|
|
2666
3414
|
init?: (("none" | "image") | null);
|
|
2667
3415
|
command?: ([string, ...(string)[]] | null);
|
|
3416
|
+
environment?: ({
|
|
3417
|
+
[k: string]: string;
|
|
3418
|
+
} | null);
|
|
3419
|
+
credentials?: (string[] | null);
|
|
3420
|
+
outbound_network_policies?: (ZoMachineListOutputV1OutboundNetworkPolicy[] | null);
|
|
3421
|
+
}
|
|
3422
|
+
export interface ZoMachineListOutputV1MachineGpu {
|
|
3423
|
+
type: ZoMachineListOutputV1GpuType;
|
|
3424
|
+
count: number;
|
|
3425
|
+
}
|
|
3426
|
+
/**
|
|
3427
|
+
* Send one slot's credential as a header on HTTPS requests to some hosts.
|
|
3428
|
+
*/
|
|
3429
|
+
export interface ZoMachineListOutputV1OutboundNetworkPolicy {
|
|
3430
|
+
/**
|
|
3431
|
+
* The connection ID.
|
|
3432
|
+
*/
|
|
3433
|
+
credential: string;
|
|
3434
|
+
/**
|
|
3435
|
+
* The connection definition's slot, by name.
|
|
3436
|
+
*/
|
|
3437
|
+
slot: string;
|
|
3438
|
+
hosts?: ([string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | null);
|
|
3439
|
+
location?: (ZoMachineListOutputV1HeaderLocation | null);
|
|
3440
|
+
format?: ((ZoMachineListOutputV1BearerFormat | ZoMachineListOutputV1BasicFormat | ZoMachineListOutputV1RawFormat) | null);
|
|
3441
|
+
}
|
|
3442
|
+
export interface ZoMachineListOutputV1HeaderLocation {
|
|
3443
|
+
type: "header";
|
|
3444
|
+
/**
|
|
3445
|
+
* The header to set, such as `Authorization` or `X-API-Key`.
|
|
3446
|
+
*/
|
|
3447
|
+
name: string;
|
|
3448
|
+
}
|
|
3449
|
+
export interface ZoMachineListOutputV1BearerFormat {
|
|
3450
|
+
/**
|
|
3451
|
+
* `Bearer <value>`.
|
|
3452
|
+
*/
|
|
3453
|
+
type: "bearer";
|
|
3454
|
+
}
|
|
3455
|
+
export interface ZoMachineListOutputV1BasicFormat {
|
|
3456
|
+
/**
|
|
3457
|
+
* `Basic` with base64 of `<username>:<value>`.
|
|
3458
|
+
*/
|
|
3459
|
+
type: "basic";
|
|
3460
|
+
username: string;
|
|
3461
|
+
}
|
|
3462
|
+
export interface ZoMachineListOutputV1RawFormat {
|
|
3463
|
+
/**
|
|
3464
|
+
* The value as it is.
|
|
3465
|
+
*/
|
|
3466
|
+
type: "raw";
|
|
2668
3467
|
}
|
|
2669
3468
|
export interface ZoMachineListOutputV1MachineBootedView {
|
|
2670
3469
|
init: ("none" | "image");
|
|
@@ -2691,6 +3490,8 @@ export interface ZoMachineListConfigurationsInputV1 {
|
|
|
2691
3490
|
*/
|
|
2692
3491
|
export interface ZoMachineListConfigurationsOutputV1 {
|
|
2693
3492
|
resources: ZoMachineListConfigurationsOutputV1MachineResourceBounds;
|
|
3493
|
+
gpus: ZoMachineListConfigurationsOutputV1MachineGpuOffer[];
|
|
3494
|
+
runtime: "vm";
|
|
2694
3495
|
vcpu_microusd_per_second: number;
|
|
2695
3496
|
memory_gib_microusd_per_second: number;
|
|
2696
3497
|
regions: string[];
|
|
@@ -2709,16 +3510,26 @@ export interface ZoMachineListConfigurationsOutputV1MachineRunBounds {
|
|
|
2709
3510
|
minimum: number;
|
|
2710
3511
|
maximum: number;
|
|
2711
3512
|
}
|
|
2712
|
-
export interface
|
|
2713
|
-
|
|
2714
|
-
|
|
2715
|
-
|
|
3513
|
+
export interface ZoMachineListConfigurationsOutputV1MachineGpuOffer {
|
|
3514
|
+
type: string;
|
|
3515
|
+
count: ZoMachineListConfigurationsOutputV1MachineRunBounds;
|
|
3516
|
+
vram_gb: number;
|
|
3517
|
+
gpu_microusd_per_second: number;
|
|
3518
|
+
runtime: "gvisor";
|
|
3519
|
+
init: ("none")[];
|
|
3520
|
+
idle_timeout_seconds: ZoMachineListConfigurationsOutputV1MachineIdleTimeoutBounds;
|
|
3521
|
+
max_run_seconds: ZoMachineListConfigurationsOutputV1MachineRunBounds;
|
|
2716
3522
|
}
|
|
2717
3523
|
export interface ZoMachineListConfigurationsOutputV1MachineIdleTimeoutBounds {
|
|
2718
3524
|
minimum: number;
|
|
2719
3525
|
maximum: number;
|
|
2720
3526
|
default: number;
|
|
2721
3527
|
}
|
|
3528
|
+
export interface ZoMachineListConfigurationsOutputV1MachineCommandOffer {
|
|
3529
|
+
supported: boolean;
|
|
3530
|
+
max_args: number;
|
|
3531
|
+
max_arg_bytes: number;
|
|
3532
|
+
}
|
|
2722
3533
|
export interface ZoMachineListFilesInputV1 {
|
|
2723
3534
|
machine_id: string;
|
|
2724
3535
|
path: string;
|
|
@@ -2764,6 +3575,7 @@ export interface ZoMachineResumeInputV1 {
|
|
|
2764
3575
|
idempotency_key: string;
|
|
2765
3576
|
accept_recovery?: boolean;
|
|
2766
3577
|
}
|
|
3578
|
+
export type ZoMachineResumeOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2767
3579
|
export type ZoMachineResumeOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2768
3580
|
/**
|
|
2769
3581
|
* A machine's registry envelope, boot settings and row-owned lifecycle state.
|
|
@@ -2774,6 +3586,7 @@ export interface ZoMachineResumeOutputV1 {
|
|
|
2774
3586
|
type: "machine";
|
|
2775
3587
|
type_version: 1;
|
|
2776
3588
|
display_name: string;
|
|
3589
|
+
description: string;
|
|
2777
3590
|
visibility: ("workspace" | "protected");
|
|
2778
3591
|
revision: number;
|
|
2779
3592
|
properties: ZoMachineResumeOutputV1MachineProperties;
|
|
@@ -2785,6 +3598,8 @@ export interface ZoMachineResumeOutputV1 {
|
|
|
2785
3598
|
created_at: string;
|
|
2786
3599
|
updated_at: string;
|
|
2787
3600
|
destroyed_at: (string | null);
|
|
3601
|
+
recoverable_until?: (string | null);
|
|
3602
|
+
recovery_acceptance_required?: boolean;
|
|
2788
3603
|
}
|
|
2789
3604
|
/**
|
|
2790
3605
|
* Public properties of a `machine` resource.
|
|
@@ -2803,11 +3618,63 @@ export interface ZoMachineResumeOutputV1MachineProperties {
|
|
|
2803
3618
|
machine_image_id: (string | null);
|
|
2804
3619
|
vcpus: (number | null);
|
|
2805
3620
|
memory_mib: (number | null);
|
|
3621
|
+
gpu?: (ZoMachineResumeOutputV1MachineGpu | null);
|
|
2806
3622
|
region: (string | null);
|
|
2807
3623
|
idle_timeout_seconds: (number | null);
|
|
2808
3624
|
max_run_seconds: (number | null);
|
|
2809
3625
|
init?: (("none" | "image") | null);
|
|
2810
3626
|
command?: ([string, ...(string)[]] | null);
|
|
3627
|
+
environment?: ({
|
|
3628
|
+
[k: string]: string;
|
|
3629
|
+
} | null);
|
|
3630
|
+
credentials?: (string[] | null);
|
|
3631
|
+
outbound_network_policies?: (ZoMachineResumeOutputV1OutboundNetworkPolicy[] | null);
|
|
3632
|
+
}
|
|
3633
|
+
export interface ZoMachineResumeOutputV1MachineGpu {
|
|
3634
|
+
type: ZoMachineResumeOutputV1GpuType;
|
|
3635
|
+
count: number;
|
|
3636
|
+
}
|
|
3637
|
+
/**
|
|
3638
|
+
* Send one slot's credential as a header on HTTPS requests to some hosts.
|
|
3639
|
+
*/
|
|
3640
|
+
export interface ZoMachineResumeOutputV1OutboundNetworkPolicy {
|
|
3641
|
+
/**
|
|
3642
|
+
* The connection ID.
|
|
3643
|
+
*/
|
|
3644
|
+
credential: string;
|
|
3645
|
+
/**
|
|
3646
|
+
* The connection definition's slot, by name.
|
|
3647
|
+
*/
|
|
3648
|
+
slot: string;
|
|
3649
|
+
hosts?: ([string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | null);
|
|
3650
|
+
location?: (ZoMachineResumeOutputV1HeaderLocation | null);
|
|
3651
|
+
format?: ((ZoMachineResumeOutputV1BearerFormat | ZoMachineResumeOutputV1BasicFormat | ZoMachineResumeOutputV1RawFormat) | null);
|
|
3652
|
+
}
|
|
3653
|
+
export interface ZoMachineResumeOutputV1HeaderLocation {
|
|
3654
|
+
type: "header";
|
|
3655
|
+
/**
|
|
3656
|
+
* The header to set, such as `Authorization` or `X-API-Key`.
|
|
3657
|
+
*/
|
|
3658
|
+
name: string;
|
|
3659
|
+
}
|
|
3660
|
+
export interface ZoMachineResumeOutputV1BearerFormat {
|
|
3661
|
+
/**
|
|
3662
|
+
* `Bearer <value>`.
|
|
3663
|
+
*/
|
|
3664
|
+
type: "bearer";
|
|
3665
|
+
}
|
|
3666
|
+
export interface ZoMachineResumeOutputV1BasicFormat {
|
|
3667
|
+
/**
|
|
3668
|
+
* `Basic` with base64 of `<username>:<value>`.
|
|
3669
|
+
*/
|
|
3670
|
+
type: "basic";
|
|
3671
|
+
username: string;
|
|
3672
|
+
}
|
|
3673
|
+
export interface ZoMachineResumeOutputV1RawFormat {
|
|
3674
|
+
/**
|
|
3675
|
+
* The value as it is.
|
|
3676
|
+
*/
|
|
3677
|
+
type: "raw";
|
|
2811
3678
|
}
|
|
2812
3679
|
export interface ZoMachineResumeOutputV1MachineBootedView {
|
|
2813
3680
|
init: ("none" | "image");
|
|
@@ -2824,6 +3691,10 @@ export interface ZoMachineSnapshotInputV1 {
|
|
|
2824
3691
|
}
|
|
2825
3692
|
export interface ZoMachineSnapshotInputV1MachineImageCreateOptions {
|
|
2826
3693
|
display_name: string;
|
|
3694
|
+
/**
|
|
3695
|
+
* Describe what this machine image is for in the user's terms.
|
|
3696
|
+
*/
|
|
3697
|
+
description?: string;
|
|
2827
3698
|
/**
|
|
2828
3699
|
* Image visibility. Omit or pass null to use the creating operation's default. Protected images use ordinary verified-human creator ownership.
|
|
2829
3700
|
*/
|
|
@@ -2842,6 +3713,7 @@ export interface ZoMachineSnapshotOutputV1 {
|
|
|
2842
3713
|
type: "machine_image";
|
|
2843
3714
|
type_version: number;
|
|
2844
3715
|
display_name: string;
|
|
3716
|
+
description: string;
|
|
2845
3717
|
visibility: ("workspace" | "protected");
|
|
2846
3718
|
revision: number;
|
|
2847
3719
|
properties: ZoMachineSnapshotOutputV1MachineImageProperties;
|
|
@@ -2868,6 +3740,7 @@ export interface ZoMachineStopInputV1 {
|
|
|
2868
3740
|
expected_revision: number;
|
|
2869
3741
|
idempotency_key: string;
|
|
2870
3742
|
}
|
|
3743
|
+
export type ZoMachineStopOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2871
3744
|
export type ZoMachineStopOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2872
3745
|
/**
|
|
2873
3746
|
* A machine's registry envelope, boot settings and row-owned lifecycle state.
|
|
@@ -2878,6 +3751,7 @@ export interface ZoMachineStopOutputV1 {
|
|
|
2878
3751
|
type: "machine";
|
|
2879
3752
|
type_version: 1;
|
|
2880
3753
|
display_name: string;
|
|
3754
|
+
description: string;
|
|
2881
3755
|
visibility: ("workspace" | "protected");
|
|
2882
3756
|
revision: number;
|
|
2883
3757
|
properties: ZoMachineStopOutputV1MachineProperties;
|
|
@@ -2889,6 +3763,8 @@ export interface ZoMachineStopOutputV1 {
|
|
|
2889
3763
|
created_at: string;
|
|
2890
3764
|
updated_at: string;
|
|
2891
3765
|
destroyed_at: (string | null);
|
|
3766
|
+
recoverable_until?: (string | null);
|
|
3767
|
+
recovery_acceptance_required?: boolean;
|
|
2892
3768
|
}
|
|
2893
3769
|
/**
|
|
2894
3770
|
* Public properties of a `machine` resource.
|
|
@@ -2907,11 +3783,63 @@ export interface ZoMachineStopOutputV1MachineProperties {
|
|
|
2907
3783
|
machine_image_id: (string | null);
|
|
2908
3784
|
vcpus: (number | null);
|
|
2909
3785
|
memory_mib: (number | null);
|
|
3786
|
+
gpu?: (ZoMachineStopOutputV1MachineGpu | null);
|
|
2910
3787
|
region: (string | null);
|
|
2911
3788
|
idle_timeout_seconds: (number | null);
|
|
2912
3789
|
max_run_seconds: (number | null);
|
|
2913
3790
|
init?: (("none" | "image") | null);
|
|
2914
3791
|
command?: ([string, ...(string)[]] | null);
|
|
3792
|
+
environment?: ({
|
|
3793
|
+
[k: string]: string;
|
|
3794
|
+
} | null);
|
|
3795
|
+
credentials?: (string[] | null);
|
|
3796
|
+
outbound_network_policies?: (ZoMachineStopOutputV1OutboundNetworkPolicy[] | null);
|
|
3797
|
+
}
|
|
3798
|
+
export interface ZoMachineStopOutputV1MachineGpu {
|
|
3799
|
+
type: ZoMachineStopOutputV1GpuType;
|
|
3800
|
+
count: number;
|
|
3801
|
+
}
|
|
3802
|
+
/**
|
|
3803
|
+
* Send one slot's credential as a header on HTTPS requests to some hosts.
|
|
3804
|
+
*/
|
|
3805
|
+
export interface ZoMachineStopOutputV1OutboundNetworkPolicy {
|
|
3806
|
+
/**
|
|
3807
|
+
* The connection ID.
|
|
3808
|
+
*/
|
|
3809
|
+
credential: string;
|
|
3810
|
+
/**
|
|
3811
|
+
* The connection definition's slot, by name.
|
|
3812
|
+
*/
|
|
3813
|
+
slot: string;
|
|
3814
|
+
hosts?: ([string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | null);
|
|
3815
|
+
location?: (ZoMachineStopOutputV1HeaderLocation | null);
|
|
3816
|
+
format?: ((ZoMachineStopOutputV1BearerFormat | ZoMachineStopOutputV1BasicFormat | ZoMachineStopOutputV1RawFormat) | null);
|
|
3817
|
+
}
|
|
3818
|
+
export interface ZoMachineStopOutputV1HeaderLocation {
|
|
3819
|
+
type: "header";
|
|
3820
|
+
/**
|
|
3821
|
+
* The header to set, such as `Authorization` or `X-API-Key`.
|
|
3822
|
+
*/
|
|
3823
|
+
name: string;
|
|
3824
|
+
}
|
|
3825
|
+
export interface ZoMachineStopOutputV1BearerFormat {
|
|
3826
|
+
/**
|
|
3827
|
+
* `Bearer <value>`.
|
|
3828
|
+
*/
|
|
3829
|
+
type: "bearer";
|
|
3830
|
+
}
|
|
3831
|
+
export interface ZoMachineStopOutputV1BasicFormat {
|
|
3832
|
+
/**
|
|
3833
|
+
* `Basic` with base64 of `<username>:<value>`.
|
|
3834
|
+
*/
|
|
3835
|
+
type: "basic";
|
|
3836
|
+
username: string;
|
|
3837
|
+
}
|
|
3838
|
+
export interface ZoMachineStopOutputV1RawFormat {
|
|
3839
|
+
/**
|
|
3840
|
+
* The value as it is.
|
|
3841
|
+
*/
|
|
3842
|
+
type: "raw";
|
|
2915
3843
|
}
|
|
2916
3844
|
export interface ZoMachineStopOutputV1MachineBootedView {
|
|
2917
3845
|
init: ("none" | "image");
|
|
@@ -2923,6 +3851,7 @@ export interface ZoMachineSystemInfoInputV1 {
|
|
|
2923
3851
|
export type ZoMachineSystemInfoOutputV1DesiredState = ("running" | "stopped" | "destroyed");
|
|
2924
3852
|
export type ZoMachineSystemInfoOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2925
3853
|
export type ZoMachineSystemInfoOutputV1InfoSource = ("provider" | "zo_control");
|
|
3854
|
+
export type ZoMachineSystemInfoOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2926
3855
|
export type ZoMachineSystemInfoOutputV1InfoGroup = ("architecture" | "os" | "allocation" | "guest" | "disk" | "network" | "accelerators" | "capabilities");
|
|
2927
3856
|
export type ZoMachineSystemInfoOutputV1InfoUnknownReason = ("not_observed" | "driver_unavailable");
|
|
2928
3857
|
/**
|
|
@@ -2971,9 +3900,14 @@ export interface ZoMachineSystemInfoOutputV1MachineInfoAllocation {
|
|
|
2971
3900
|
observed_at: string;
|
|
2972
3901
|
requested_vcpus: number;
|
|
2973
3902
|
requested_memory_mib: number;
|
|
3903
|
+
requested_gpu?: (ZoMachineSystemInfoOutputV1MachineGpu | null);
|
|
2974
3904
|
verified_vcpus: (number | null);
|
|
2975
3905
|
verified_memory_mib: (number | null);
|
|
2976
3906
|
}
|
|
3907
|
+
export interface ZoMachineSystemInfoOutputV1MachineGpu {
|
|
3908
|
+
type: ZoMachineSystemInfoOutputV1GpuType;
|
|
3909
|
+
count: number;
|
|
3910
|
+
}
|
|
2977
3911
|
/**
|
|
2978
3912
|
* What the machine's driver supports, not what the caller may do.
|
|
2979
3913
|
* ``stop`` keeps the filesystem; ``pause`` keeps memory too.
|
|
@@ -3004,19 +3938,37 @@ export interface ZoMachineUpdateInputV1 {
|
|
|
3004
3938
|
machine_id: string;
|
|
3005
3939
|
expected_revision: number;
|
|
3006
3940
|
display_name?: (string | null);
|
|
3941
|
+
/**
|
|
3942
|
+
* Describe what this machine is for in the user's terms.
|
|
3943
|
+
*/
|
|
3944
|
+
description?: (string | null);
|
|
3007
3945
|
lifecycle?: (ZoMachineUpdateInputV1MachineLifecycleUpdate | null);
|
|
3008
3946
|
/**
|
|
3009
|
-
* Which process runs first at boot. `none` (default): nothing; the machine waits for exec. `image`: the image's init system (systemd, OpenRC) becomes PID 1 and starts enabled services. `source.machine_image_id` chooses the image. Debian and Ubuntu need `systemd systemd-sysv`.
|
|
3947
|
+
* Which process runs first at boot. `none` (default): nothing; the machine waits for exec. `image`: the image's init system (systemd, OpenRC) becomes PID 1 and starts enabled services. `source.machine_image_id` chooses the image. Debian and Ubuntu need `systemd systemd-sysv`. Write access to boot files can run code as root at next boot.
|
|
3010
3948
|
*/
|
|
3011
3949
|
init?: (("none" | "image") | null);
|
|
3012
3950
|
/**
|
|
3013
|
-
* Set the main process for the next resume. Arguments run without a shell; use ["sh", "-c", ...] for shell syntax. Find ENTRYPOINT and CMD on the image's registry page; Zo does not return them. Pass ENTRYPOINT then CMD. With `init: image`, wait for needed services. The machine stops when the command exits; resume runs it again. It may run more than once after a lost create or resume response, so make it safe to rerun. Each argument is at most 4,096 UTF-8 bytes and all arguments total at most 65,536 bytes. A running command is not activity: set `idle_timeout_seconds` at least as long as the job. The maximum is published by `zo.machine.list_configurations
|
|
3951
|
+
* Set the main process for the next resume. Arguments run without a shell; use ["sh", "-c", ...] for shell syntax. Find ENTRYPOINT and CMD on the image's registry page; Zo does not return them. Pass ENTRYPOINT then CMD. With `init: image`, wait for needed services. The machine stops when the command exits; resume runs it again. It may run more than once after a lost create or resume response, so make it safe to rerun. Each argument is at most 4,096 UTF-8 bytes and all arguments total at most 65,536 bytes. A running command is not activity: set `idle_timeout_seconds` at least as long as the job. The maximum is published by `zo.machine.list_configurations`: 3,600 s for CPU machines and 86,400 s for GPU machines. Longer CPU jobs need Zo exec or file calls, or HTTP through a tunnel or connect token. After exit, `get` may show `running` for a few minutes. Zo reports no exit reason or code. Write a job's result to disk. A resume runs the command again, so to read it, clear the command, resume, then use `zo.machine.read_bytes`. With `init: image` and a command, a missing `/sbin/init` ends the generation as an exit stop, without `incompatible_image`. Write access to its script can run code as root at next boot.
|
|
3014
3952
|
*/
|
|
3015
3953
|
command?: ([string, ...(string)[]] | null);
|
|
3016
3954
|
/**
|
|
3017
|
-
* Remove the main process on the next resume.
|
|
3955
|
+
* Remove the main process on the next resume.
|
|
3018
3956
|
*/
|
|
3019
3957
|
clear_command?: boolean;
|
|
3958
|
+
/**
|
|
3959
|
+
* The environment that replaces the stored one; omit it to keep it. Environment variables set, exactly as written, in the boot process and every command run on the machine. Plain strings, not secrets: they are part of the machine's configuration, which anyone who can read the machine sees. Names are upper-case letters, digits and underscores, and reserved names such as `PATH` or ones starting with `ZO_` are refused; at most 64 variables of at most 4096 characters each. A variable here wins over a connection in `credentials` that sets the same name.
|
|
3960
|
+
*/
|
|
3961
|
+
environment?: ({
|
|
3962
|
+
[k: string]: string;
|
|
3963
|
+
} | null);
|
|
3964
|
+
/**
|
|
3965
|
+
* The list that replaces the stored one; omit it to keep it. Connection IDs whose credentials the machine receives as environment variables, in the boot process and every command. Each slot of a listed connection sets the variable its definition names, with the variables the slot and the connection declare. The machine also needs a use grant on each connection (`zo.grant.create` with the machine as assignee); a listed connection without one delivers nothing. When two listed connections set the same variable, the later one in the list wins. At most 100 connections, each listed once.
|
|
3966
|
+
*/
|
|
3967
|
+
credentials?: (string[] | null);
|
|
3968
|
+
/**
|
|
3969
|
+
* The rules that replace the stored ones; omit them to keep them. A running machine's requests use the new rules once the update returns. Header rules: on HTTPS requests from the machine to a rule's hosts, Zo sets a header built from a connection's credential, and the credential never enters the machine. A rule names the connection (`credential`) and one of its definition's slots (`slot`). With only those two, it uses the hosts, header and format the slot declares in its `injections`. It may give its own `hosts`, `location` and `format`, all three together, only for a slot that declares an `environment_variable`. Formats: `bearer` (`Bearer <value>`), `basic` with a `username` (`Basic` with base64 of `<username>:<value>`) and `raw` (the value as stored). A rule sets its header only while the machine holds a use grant on the connection. Two rules can't set the same header on the same host, and all rules together set at most 25 header values. Requests to a host with a rule use HTTP/1.1.
|
|
3970
|
+
*/
|
|
3971
|
+
outbound_network_policies?: (ZoMachineUpdateInputV1OutboundNetworkPolicy[] | null);
|
|
3020
3972
|
}
|
|
3021
3973
|
/**
|
|
3022
3974
|
* The timers a caller may change after create. Modal fixes them at
|
|
@@ -3026,10 +3978,53 @@ export interface ZoMachineUpdateInputV1MachineLifecycleUpdate {
|
|
|
3026
3978
|
idle_timeout_seconds?: (number | null);
|
|
3027
3979
|
max_run_seconds?: (number | null);
|
|
3028
3980
|
}
|
|
3981
|
+
/**
|
|
3982
|
+
* Send one slot's credential as a header on HTTPS requests to some hosts.
|
|
3983
|
+
*/
|
|
3984
|
+
export interface ZoMachineUpdateInputV1OutboundNetworkPolicy {
|
|
3985
|
+
/**
|
|
3986
|
+
* The connection ID.
|
|
3987
|
+
*/
|
|
3988
|
+
credential: string;
|
|
3989
|
+
/**
|
|
3990
|
+
* The connection definition's slot, by name.
|
|
3991
|
+
*/
|
|
3992
|
+
slot: string;
|
|
3993
|
+
hosts?: ([string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | null);
|
|
3994
|
+
location?: (ZoMachineUpdateInputV1HeaderLocation | null);
|
|
3995
|
+
format?: ((ZoMachineUpdateInputV1BearerFormat | ZoMachineUpdateInputV1BasicFormat | ZoMachineUpdateInputV1RawFormat) | null);
|
|
3996
|
+
}
|
|
3997
|
+
export interface ZoMachineUpdateInputV1HeaderLocation {
|
|
3998
|
+
type: "header";
|
|
3999
|
+
/**
|
|
4000
|
+
* The header to set, such as `Authorization` or `X-API-Key`.
|
|
4001
|
+
*/
|
|
4002
|
+
name: string;
|
|
4003
|
+
}
|
|
4004
|
+
export interface ZoMachineUpdateInputV1BearerFormat {
|
|
4005
|
+
/**
|
|
4006
|
+
* `Bearer <value>`.
|
|
4007
|
+
*/
|
|
4008
|
+
type: "bearer";
|
|
4009
|
+
}
|
|
4010
|
+
export interface ZoMachineUpdateInputV1BasicFormat {
|
|
4011
|
+
/**
|
|
4012
|
+
* `Basic` with base64 of `<username>:<value>`.
|
|
4013
|
+
*/
|
|
4014
|
+
type: "basic";
|
|
4015
|
+
username: string;
|
|
4016
|
+
}
|
|
4017
|
+
export interface ZoMachineUpdateInputV1RawFormat {
|
|
4018
|
+
/**
|
|
4019
|
+
* The value as it is.
|
|
4020
|
+
*/
|
|
4021
|
+
type: "raw";
|
|
4022
|
+
}
|
|
3029
4023
|
export interface ZoMachineUpdateOutputV1 {
|
|
3030
4024
|
machine_id: string;
|
|
3031
4025
|
revision: number;
|
|
3032
4026
|
display_name: string;
|
|
4027
|
+
description: string;
|
|
3033
4028
|
idle_timeout_seconds: number;
|
|
3034
4029
|
max_run_seconds: (number | null);
|
|
3035
4030
|
}
|
|
@@ -3063,6 +4058,7 @@ export interface ZoMachineImageDeleteOutputV1 {
|
|
|
3063
4058
|
type: "machine_image";
|
|
3064
4059
|
type_version: number;
|
|
3065
4060
|
display_name: string;
|
|
4061
|
+
description: string;
|
|
3066
4062
|
visibility: ("workspace" | "protected");
|
|
3067
4063
|
revision: number;
|
|
3068
4064
|
properties: ZoMachineImageDeleteOutputV1MachineImageProperties;
|
|
@@ -3100,6 +4096,7 @@ export interface ZoMachineImageGetOutputV1 {
|
|
|
3100
4096
|
type: "machine_image";
|
|
3101
4097
|
type_version: number;
|
|
3102
4098
|
display_name: string;
|
|
4099
|
+
description: string;
|
|
3103
4100
|
visibility: ("workspace" | "protected");
|
|
3104
4101
|
revision: number;
|
|
3105
4102
|
properties: ZoMachineImageGetOutputV1MachineImageProperties;
|
|
@@ -3123,6 +4120,10 @@ export interface ZoMachineImageGetOutputV1MachineImageProperties {
|
|
|
3123
4120
|
}
|
|
3124
4121
|
export interface ZoMachineImageImportInputV1 {
|
|
3125
4122
|
display_name: string;
|
|
4123
|
+
/**
|
|
4124
|
+
* Describe what this machine image is for in the user's terms.
|
|
4125
|
+
*/
|
|
4126
|
+
description?: string;
|
|
3126
4127
|
/**
|
|
3127
4128
|
* `workspace` (default): every member can see and use it. `protected`: only you, and whoever you share it with; workspace-wide grants don't reach it. Fixed at creation.
|
|
3128
4129
|
*/
|
|
@@ -3149,6 +4150,7 @@ export interface ZoMachineImageImportOutputV1 {
|
|
|
3149
4150
|
type: "machine_image";
|
|
3150
4151
|
type_version: number;
|
|
3151
4152
|
display_name: string;
|
|
4153
|
+
description: string;
|
|
3152
4154
|
visibility: ("workspace" | "protected");
|
|
3153
4155
|
revision: number;
|
|
3154
4156
|
properties: ZoMachineImageImportOutputV1MachineImageProperties;
|
|
@@ -3190,6 +4192,7 @@ export interface ZoMachineImageListOutputV1MachineImageView {
|
|
|
3190
4192
|
type: "machine_image";
|
|
3191
4193
|
type_version: number;
|
|
3192
4194
|
display_name: string;
|
|
4195
|
+
description: string;
|
|
3193
4196
|
visibility: ("workspace" | "protected");
|
|
3194
4197
|
revision: number;
|
|
3195
4198
|
properties: ZoMachineImageListOutputV1MachineImageProperties;
|
|
@@ -3222,6 +4225,50 @@ export interface ZoMachineImageListQueryV1 {
|
|
|
3222
4225
|
cursor?: string;
|
|
3223
4226
|
sort?: ("id.asc" | "created_at.desc" | "created_at.asc" | "display_name.asc");
|
|
3224
4227
|
}
|
|
4228
|
+
export interface ZoMachineImageUpdateInputV1 {
|
|
4229
|
+
machine_image_id: string;
|
|
4230
|
+
expected_revision: number;
|
|
4231
|
+
display_name?: (string | null);
|
|
4232
|
+
/**
|
|
4233
|
+
* "" clears the description.
|
|
4234
|
+
*/
|
|
4235
|
+
description?: (string | null);
|
|
4236
|
+
}
|
|
4237
|
+
export type ZoMachineImageUpdateOutputV1ImageOrigin = ("registry" | "build" | "machine_snapshot");
|
|
4238
|
+
export type ZoMachineImageUpdateOutputV1ImageStatus = ("pending" | "preparing" | "ready" | "failed" | "deleting" | "deleted");
|
|
4239
|
+
/**
|
|
4240
|
+
* A `machine_image` resource with its preparation status. ``source_digest``
|
|
4241
|
+
* is the pinned manifest digest once resolved; ``error_code`` is set only for
|
|
4242
|
+
* an image that failed.
|
|
4243
|
+
*/
|
|
4244
|
+
export interface ZoMachineImageUpdateOutputV1 {
|
|
4245
|
+
id: string;
|
|
4246
|
+
workspace_id: string;
|
|
4247
|
+
type: "machine_image";
|
|
4248
|
+
type_version: number;
|
|
4249
|
+
display_name: string;
|
|
4250
|
+
description: string;
|
|
4251
|
+
visibility: ("workspace" | "protected");
|
|
4252
|
+
revision: number;
|
|
4253
|
+
properties: ZoMachineImageUpdateOutputV1MachineImageProperties;
|
|
4254
|
+
status: ZoMachineImageUpdateOutputV1ImageStatus;
|
|
4255
|
+
source_digest: (string | null);
|
|
4256
|
+
error_code: (string | null);
|
|
4257
|
+
created_at: string;
|
|
4258
|
+
ready_at: (string | null);
|
|
4259
|
+
deleted_at: (string | null);
|
|
4260
|
+
}
|
|
4261
|
+
/**
|
|
4262
|
+
* Public properties of a `machine_image` resource, type version 1: what
|
|
4263
|
+
* the image is, fixed when it was admitted. Status and the resolved digest
|
|
4264
|
+
* live on the ``machine_images`` row, not in the registry.
|
|
4265
|
+
*/
|
|
4266
|
+
export interface ZoMachineImageUpdateOutputV1MachineImageProperties {
|
|
4267
|
+
origin: ZoMachineImageUpdateOutputV1ImageOrigin;
|
|
4268
|
+
artifact_format: ("oci" | "provider_filesystem_snapshot");
|
|
4269
|
+
architecture: ("amd64" | "arm64");
|
|
4270
|
+
source_ref: (string | null);
|
|
4271
|
+
}
|
|
3225
4272
|
export interface ZoMessageGetInputV1 {
|
|
3226
4273
|
/**
|
|
3227
4274
|
* The Agent that sent or received the message.
|
|
@@ -3289,6 +4336,14 @@ export interface ZoMessageGetOutputV1MessageDelivery {
|
|
|
3289
4336
|
*/
|
|
3290
4337
|
outcome: (("completed" | "cancelled" | "interrupted" | "failed") | null);
|
|
3291
4338
|
outcome_reason: (string | null);
|
|
4339
|
+
/**
|
|
4340
|
+
* The model the message was admitted with: the one it named, else the session's.
|
|
4341
|
+
*/
|
|
4342
|
+
model: (string | null);
|
|
4343
|
+
/**
|
|
4344
|
+
* The reasoning level the message was admitted with; null for the model's default.
|
|
4345
|
+
*/
|
|
4346
|
+
reasoning: (string | null);
|
|
3292
4347
|
}
|
|
3293
4348
|
export interface ZoOauthAppCreateInputV1 {
|
|
3294
4349
|
workspace_id: string;
|
|
@@ -3422,14 +4477,185 @@ export interface ZoOauthAppUpdateOutputV1 {
|
|
|
3422
4477
|
manager_ref: {
|
|
3423
4478
|
[k: string]: JsonValue;
|
|
3424
4479
|
};
|
|
3425
|
-
visibility: ("private" | "public");
|
|
3426
|
-
requested_scopes: string[];
|
|
3427
|
-
connection_id: (string | null);
|
|
3428
|
-
state: string;
|
|
4480
|
+
visibility: ("private" | "public");
|
|
4481
|
+
requested_scopes: string[];
|
|
4482
|
+
connection_id: (string | null);
|
|
4483
|
+
state: string;
|
|
4484
|
+
}
|
|
4485
|
+
export interface ZoQuotaGetInputV1 {
|
|
4486
|
+
workspace_id: string;
|
|
4487
|
+
/**
|
|
4488
|
+
* Public quota definitions:
|
|
4489
|
+
* database.count: Databases not yet deleted, including creation and deletion in progress. Kind: capacity; scope: workspace; unit: database; measurement: databases_not_deleted.
|
|
4490
|
+
* database.storage_per_database: Desired storage ceiling for each database; a provider update may still be pending. Kind: per_resource_bound; scope: resource (database); unit: byte; measurement: not_applicable.
|
|
4491
|
+
* knowledge.storage: Stored and reserved Knowledge bytes. Kind: capacity; scope: workspace; unit: byte; measurement: stored_bytes_plus_reserved_bytes.
|
|
4492
|
+
* machine.allocated_gpus: GPU count in unreleased compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: gpu; measurement: unreleased_allocations_including_pending_starts.
|
|
4493
|
+
* machine.allocated_machines: Unreleased machine compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: machine; measurement: unreleased_allocations_including_pending_starts.
|
|
4494
|
+
* machine.allocated_memory: Memory in unreleased compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: MiB; measurement: unreleased_allocations_including_pending_starts.
|
|
4495
|
+
* machine.allocated_vcpus: vCPUs in unreleased compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: vcpu; measurement: unreleased_allocations_including_pending_starts.
|
|
4496
|
+
* machine.concurrent_image_builds: Image builds in pending or preparing states. Kind: capacity; scope: workspace; unit: build; measurement: pending_and_preparing_images.
|
|
4497
|
+
* machine.image_builds_24h: Registry and build-origin images created in the trailing 86400 seconds. Kind: windowed; scope: workspace; unit: build; measurement: registry_and_build_images_created_in_trailing_86400_seconds.
|
|
4498
|
+
* machine.image_lineage_depth: Maximum lineage depth of one machine image. Kind: per_resource_bound; scope: resource (machine_image); unit: level; measurement: not_applicable.
|
|
4499
|
+
* machine.memory_per_machine: Maximum memory allocated to one machine. Kind: per_resource_bound; scope: resource (machine); unit: MiB; measurement: not_applicable.
|
|
4500
|
+
* machine.period_spend: Billed and proven unbilled machine compute in the workspace billing period; this allowance is not available credit. Kind: windowed; scope: workspace; unit: USD; measurement: billed_and_proven_unbilled_compute_in_billing_period.
|
|
4501
|
+
* machine.retained_images: Images not yet deleted, including unfinished images. Kind: capacity; scope: workspace; unit: image; measurement: images_not_deleted.
|
|
4502
|
+
* machine.retained_storage: Latest retained root and volume storage measurements under admission retention rules. Kind: capacity; scope: workspace; unit: byte; measurement: latest_retained_root_and_volume_measurements.
|
|
4503
|
+
* machine.vcpus_per_machine: Maximum vCPUs allocated to one machine. Kind: per_resource_bound; scope: resource (machine); unit: vcpu; measurement: not_applicable.
|
|
4504
|
+
* workspace.members: Memberships and live invitations occupying admission slots. Kind: capacity; scope: workspace; unit: member; measurement: memberships_and_live_invitations.
|
|
4505
|
+
*/
|
|
4506
|
+
quota_key: ("database.count" | "database.storage_per_database" | "knowledge.storage" | "machine.allocated_gpus" | "machine.allocated_machines" | "machine.allocated_memory" | "machine.allocated_vcpus" | "machine.concurrent_image_builds" | "machine.image_builds_24h" | "machine.image_lineage_depth" | "machine.memory_per_machine" | "machine.period_spend" | "machine.retained_images" | "machine.retained_storage" | "machine.vcpus_per_machine" | "workspace.members");
|
|
4507
|
+
}
|
|
4508
|
+
export interface ZoQuotaGetOutputV1 {
|
|
4509
|
+
workspace_id: string;
|
|
4510
|
+
/**
|
|
4511
|
+
* Public quota definitions:
|
|
4512
|
+
* database.count: Databases not yet deleted, including creation and deletion in progress. Kind: capacity; scope: workspace; unit: database; measurement: databases_not_deleted.
|
|
4513
|
+
* database.storage_per_database: Desired storage ceiling for each database; a provider update may still be pending. Kind: per_resource_bound; scope: resource (database); unit: byte; measurement: not_applicable.
|
|
4514
|
+
* knowledge.storage: Stored and reserved Knowledge bytes. Kind: capacity; scope: workspace; unit: byte; measurement: stored_bytes_plus_reserved_bytes.
|
|
4515
|
+
* machine.allocated_gpus: GPU count in unreleased compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: gpu; measurement: unreleased_allocations_including_pending_starts.
|
|
4516
|
+
* machine.allocated_machines: Unreleased machine compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: machine; measurement: unreleased_allocations_including_pending_starts.
|
|
4517
|
+
* machine.allocated_memory: Memory in unreleased compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: MiB; measurement: unreleased_allocations_including_pending_starts.
|
|
4518
|
+
* machine.allocated_vcpus: vCPUs in unreleased compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: vcpu; measurement: unreleased_allocations_including_pending_starts.
|
|
4519
|
+
* machine.concurrent_image_builds: Image builds in pending or preparing states. Kind: capacity; scope: workspace; unit: build; measurement: pending_and_preparing_images.
|
|
4520
|
+
* machine.image_builds_24h: Registry and build-origin images created in the trailing 86400 seconds. Kind: windowed; scope: workspace; unit: build; measurement: registry_and_build_images_created_in_trailing_86400_seconds.
|
|
4521
|
+
* machine.image_lineage_depth: Maximum lineage depth of one machine image. Kind: per_resource_bound; scope: resource (machine_image); unit: level; measurement: not_applicable.
|
|
4522
|
+
* machine.memory_per_machine: Maximum memory allocated to one machine. Kind: per_resource_bound; scope: resource (machine); unit: MiB; measurement: not_applicable.
|
|
4523
|
+
* machine.period_spend: Billed and proven unbilled machine compute in the workspace billing period; this allowance is not available credit. Kind: windowed; scope: workspace; unit: USD; measurement: billed_and_proven_unbilled_compute_in_billing_period.
|
|
4524
|
+
* machine.retained_images: Images not yet deleted, including unfinished images. Kind: capacity; scope: workspace; unit: image; measurement: images_not_deleted.
|
|
4525
|
+
* machine.retained_storage: Latest retained root and volume storage measurements under admission retention rules. Kind: capacity; scope: workspace; unit: byte; measurement: latest_retained_root_and_volume_measurements.
|
|
4526
|
+
* machine.vcpus_per_machine: Maximum vCPUs allocated to one machine. Kind: per_resource_bound; scope: resource (machine); unit: vcpu; measurement: not_applicable.
|
|
4527
|
+
* workspace.members: Memberships and live invitations occupying admission slots. Kind: capacity; scope: workspace; unit: member; measurement: memberships_and_live_invitations.
|
|
4528
|
+
*/
|
|
4529
|
+
quota_key: ("database.count" | "database.storage_per_database" | "knowledge.storage" | "machine.allocated_gpus" | "machine.allocated_machines" | "machine.allocated_memory" | "machine.allocated_vcpus" | "machine.concurrent_image_builds" | "machine.image_builds_24h" | "machine.image_lineage_depth" | "machine.memory_per_machine" | "machine.period_spend" | "machine.retained_images" | "machine.retained_storage" | "machine.vcpus_per_machine" | "workspace.members");
|
|
4530
|
+
description: string;
|
|
4531
|
+
kind: ("capacity" | "windowed" | "per_resource_bound");
|
|
4532
|
+
scope: ZoQuotaGetOutputV1QuotaScope;
|
|
4533
|
+
unit: string;
|
|
4534
|
+
limit: ZoQuotaGetOutputV1QuotaLimit;
|
|
4535
|
+
measurement: ZoQuotaGetOutputV1QuotaMeasurement;
|
|
4536
|
+
headroom: ZoQuotaGetOutputV1QuotaRemainder;
|
|
4537
|
+
overage: ZoQuotaGetOutputV1QuotaRemainder;
|
|
4538
|
+
}
|
|
4539
|
+
export interface ZoQuotaGetOutputV1QuotaScope {
|
|
4540
|
+
kind: ("workspace" | "resource");
|
|
4541
|
+
resource_type?: (string | null);
|
|
4542
|
+
}
|
|
4543
|
+
export interface ZoQuotaGetOutputV1QuotaLimit {
|
|
4544
|
+
kind: ("finite" | "unlimited" | "not_configured" | "unavailable");
|
|
4545
|
+
amount?: (string | null);
|
|
4546
|
+
}
|
|
4547
|
+
export interface ZoQuotaGetOutputV1QuotaMeasurement {
|
|
4548
|
+
status: ("available" | "unavailable" | "not_configured" | "not_applicable");
|
|
4549
|
+
amount?: (string | null);
|
|
4550
|
+
observed_at?: (string | null);
|
|
4551
|
+
basis?: (string | null);
|
|
4552
|
+
used?: (string | null);
|
|
4553
|
+
reserved?: (string | null);
|
|
4554
|
+
window?: (ZoQuotaGetOutputV1QuotaWindow | null);
|
|
4555
|
+
}
|
|
4556
|
+
export interface ZoQuotaGetOutputV1QuotaWindow {
|
|
4557
|
+
start: string;
|
|
4558
|
+
end: string;
|
|
4559
|
+
rule: ("trailing_86400_seconds" | "billing_period");
|
|
4560
|
+
}
|
|
4561
|
+
export interface ZoQuotaGetOutputV1QuotaRemainder {
|
|
4562
|
+
status: ("available" | "unknown" | "unlimited" | "not_configured" | "not_applicable");
|
|
4563
|
+
amount?: (string | null);
|
|
4564
|
+
}
|
|
4565
|
+
export interface ZoQuotaListInputV1 {
|
|
4566
|
+
workspace_id: string;
|
|
4567
|
+
}
|
|
4568
|
+
export interface ZoQuotaListOutputV1 {
|
|
4569
|
+
quotas: ZoQuotaListOutputV1QuotaReading[];
|
|
4570
|
+
next_cursor?: (string | null);
|
|
4571
|
+
observed_at: string;
|
|
4572
|
+
}
|
|
4573
|
+
export interface ZoQuotaListOutputV1QuotaReading {
|
|
4574
|
+
workspace_id: string;
|
|
4575
|
+
/**
|
|
4576
|
+
* Public quota definitions:
|
|
4577
|
+
* database.count: Databases not yet deleted, including creation and deletion in progress. Kind: capacity; scope: workspace; unit: database; measurement: databases_not_deleted.
|
|
4578
|
+
* database.storage_per_database: Desired storage ceiling for each database; a provider update may still be pending. Kind: per_resource_bound; scope: resource (database); unit: byte; measurement: not_applicable.
|
|
4579
|
+
* knowledge.storage: Stored and reserved Knowledge bytes. Kind: capacity; scope: workspace; unit: byte; measurement: stored_bytes_plus_reserved_bytes.
|
|
4580
|
+
* machine.allocated_gpus: GPU count in unreleased compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: gpu; measurement: unreleased_allocations_including_pending_starts.
|
|
4581
|
+
* machine.allocated_machines: Unreleased machine compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: machine; measurement: unreleased_allocations_including_pending_starts.
|
|
4582
|
+
* machine.allocated_memory: Memory in unreleased compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: MiB; measurement: unreleased_allocations_including_pending_starts.
|
|
4583
|
+
* machine.allocated_vcpus: vCPUs in unreleased compute allocations, including pending starts. Kind: capacity; scope: workspace; unit: vcpu; measurement: unreleased_allocations_including_pending_starts.
|
|
4584
|
+
* machine.concurrent_image_builds: Image builds in pending or preparing states. Kind: capacity; scope: workspace; unit: build; measurement: pending_and_preparing_images.
|
|
4585
|
+
* machine.image_builds_24h: Registry and build-origin images created in the trailing 86400 seconds. Kind: windowed; scope: workspace; unit: build; measurement: registry_and_build_images_created_in_trailing_86400_seconds.
|
|
4586
|
+
* machine.image_lineage_depth: Maximum lineage depth of one machine image. Kind: per_resource_bound; scope: resource (machine_image); unit: level; measurement: not_applicable.
|
|
4587
|
+
* machine.memory_per_machine: Maximum memory allocated to one machine. Kind: per_resource_bound; scope: resource (machine); unit: MiB; measurement: not_applicable.
|
|
4588
|
+
* machine.period_spend: Billed and proven unbilled machine compute in the workspace billing period; this allowance is not available credit. Kind: windowed; scope: workspace; unit: USD; measurement: billed_and_proven_unbilled_compute_in_billing_period.
|
|
4589
|
+
* machine.retained_images: Images not yet deleted, including unfinished images. Kind: capacity; scope: workspace; unit: image; measurement: images_not_deleted.
|
|
4590
|
+
* machine.retained_storage: Latest retained root and volume storage measurements under admission retention rules. Kind: capacity; scope: workspace; unit: byte; measurement: latest_retained_root_and_volume_measurements.
|
|
4591
|
+
* machine.vcpus_per_machine: Maximum vCPUs allocated to one machine. Kind: per_resource_bound; scope: resource (machine); unit: vcpu; measurement: not_applicable.
|
|
4592
|
+
* workspace.members: Memberships and live invitations occupying admission slots. Kind: capacity; scope: workspace; unit: member; measurement: memberships_and_live_invitations.
|
|
4593
|
+
*/
|
|
4594
|
+
quota_key: ("database.count" | "database.storage_per_database" | "knowledge.storage" | "machine.allocated_gpus" | "machine.allocated_machines" | "machine.allocated_memory" | "machine.allocated_vcpus" | "machine.concurrent_image_builds" | "machine.image_builds_24h" | "machine.image_lineage_depth" | "machine.memory_per_machine" | "machine.period_spend" | "machine.retained_images" | "machine.retained_storage" | "machine.vcpus_per_machine" | "workspace.members");
|
|
4595
|
+
description: string;
|
|
4596
|
+
kind: ("capacity" | "windowed" | "per_resource_bound");
|
|
4597
|
+
scope: ZoQuotaListOutputV1QuotaScope;
|
|
4598
|
+
unit: string;
|
|
4599
|
+
limit: ZoQuotaListOutputV1QuotaLimit;
|
|
4600
|
+
measurement: ZoQuotaListOutputV1QuotaMeasurement;
|
|
4601
|
+
headroom: ZoQuotaListOutputV1QuotaRemainder;
|
|
4602
|
+
overage: ZoQuotaListOutputV1QuotaRemainder;
|
|
4603
|
+
}
|
|
4604
|
+
export interface ZoQuotaListOutputV1QuotaScope {
|
|
4605
|
+
kind: ("workspace" | "resource");
|
|
4606
|
+
resource_type?: (string | null);
|
|
4607
|
+
}
|
|
4608
|
+
export interface ZoQuotaListOutputV1QuotaLimit {
|
|
4609
|
+
kind: ("finite" | "unlimited" | "not_configured" | "unavailable");
|
|
4610
|
+
amount?: (string | null);
|
|
4611
|
+
}
|
|
4612
|
+
export interface ZoQuotaListOutputV1QuotaMeasurement {
|
|
4613
|
+
status: ("available" | "unavailable" | "not_configured" | "not_applicable");
|
|
4614
|
+
amount?: (string | null);
|
|
4615
|
+
observed_at?: (string | null);
|
|
4616
|
+
basis?: (string | null);
|
|
4617
|
+
used?: (string | null);
|
|
4618
|
+
reserved?: (string | null);
|
|
4619
|
+
window?: (ZoQuotaListOutputV1QuotaWindow | null);
|
|
4620
|
+
}
|
|
4621
|
+
export interface ZoQuotaListOutputV1QuotaWindow {
|
|
4622
|
+
start: string;
|
|
4623
|
+
end: string;
|
|
4624
|
+
rule: ("trailing_86400_seconds" | "billing_period");
|
|
4625
|
+
}
|
|
4626
|
+
export interface ZoQuotaListOutputV1QuotaRemainder {
|
|
4627
|
+
status: ("available" | "unknown" | "unlimited" | "not_configured" | "not_applicable");
|
|
4628
|
+
amount?: (string | null);
|
|
4629
|
+
}
|
|
4630
|
+
export interface ZoQuotaListQueryV1 {
|
|
4631
|
+
/**
|
|
4632
|
+
* Rows per page, at most 100; a larger value is reduced to it.
|
|
4633
|
+
*/
|
|
4634
|
+
limit?: number;
|
|
4635
|
+
/**
|
|
4636
|
+
* The previous page's next_cursor, sent with the same sort, filter and search.
|
|
4637
|
+
*/
|
|
4638
|
+
cursor?: string;
|
|
4639
|
+
sort?: ("quota_key.asc" | "quota_key.desc");
|
|
4640
|
+
filter?: {
|
|
4641
|
+
kind?: (("capacity" | "windowed" | "per_resource_bound") | null);
|
|
4642
|
+
scope?: (("workspace" | "resource") | null);
|
|
4643
|
+
resource_type?: (("machine" | "machine_image" | "database") | null);
|
|
4644
|
+
};
|
|
3429
4645
|
}
|
|
3430
4646
|
export interface ZoScheduleCreateInputV1 {
|
|
4647
|
+
/**
|
|
4648
|
+
* @maxItems 100
|
|
4649
|
+
*
|
|
4650
|
+
* Items: A tag ID or name; unknown names are created, unknown IDs are refused.
|
|
4651
|
+
*/
|
|
4652
|
+
tags?: string[];
|
|
3431
4653
|
workspace_id: string;
|
|
3432
4654
|
display_name: string;
|
|
4655
|
+
/**
|
|
4656
|
+
* Describe what this schedule is for in the user's terms.
|
|
4657
|
+
*/
|
|
4658
|
+
description?: string;
|
|
3433
4659
|
rrule: string;
|
|
3434
4660
|
start_at: string;
|
|
3435
4661
|
timezone: string;
|
|
@@ -3444,6 +4670,7 @@ export interface ZoScheduleCreateOutputV1 {
|
|
|
3444
4670
|
type: "schedule";
|
|
3445
4671
|
type_version: number;
|
|
3446
4672
|
display_name: string;
|
|
4673
|
+
description: string;
|
|
3447
4674
|
revision: number;
|
|
3448
4675
|
visibility: ("workspace" | "protected");
|
|
3449
4676
|
owner_user_id: (string | null);
|
|
@@ -3483,6 +4710,7 @@ export interface ZoScheduleGetOutputV1 {
|
|
|
3483
4710
|
type: "schedule";
|
|
3484
4711
|
type_version: number;
|
|
3485
4712
|
display_name: string;
|
|
4713
|
+
description: string;
|
|
3486
4714
|
revision: number;
|
|
3487
4715
|
visibility: ("workspace" | "protected");
|
|
3488
4716
|
owner_user_id: (string | null);
|
|
@@ -3518,6 +4746,7 @@ export interface ZoScheduleListOutputV1ScheduleView {
|
|
|
3518
4746
|
type: "schedule";
|
|
3519
4747
|
type_version: number;
|
|
3520
4748
|
display_name: string;
|
|
4749
|
+
description: string;
|
|
3521
4750
|
revision: number;
|
|
3522
4751
|
visibility: ("workspace" | "protected");
|
|
3523
4752
|
owner_user_id: (string | null);
|
|
@@ -3551,6 +4780,10 @@ export interface ZoScheduleUpdateInputV1 {
|
|
|
3551
4780
|
schedule_id: string;
|
|
3552
4781
|
expected_revision: number;
|
|
3553
4782
|
display_name: string;
|
|
4783
|
+
/**
|
|
4784
|
+
* Describe what this schedule is for in the user's terms.
|
|
4785
|
+
*/
|
|
4786
|
+
description?: (string | null);
|
|
3554
4787
|
rrule: string;
|
|
3555
4788
|
start_at: string;
|
|
3556
4789
|
timezone: string;
|
|
@@ -3565,6 +4798,7 @@ export interface ZoScheduleUpdateOutputV1 {
|
|
|
3565
4798
|
type: "schedule";
|
|
3566
4799
|
type_version: number;
|
|
3567
4800
|
display_name: string;
|
|
4801
|
+
description: string;
|
|
3568
4802
|
revision: number;
|
|
3569
4803
|
visibility: ("workspace" | "protected");
|
|
3570
4804
|
owner_user_id: (string | null);
|
|
@@ -3628,6 +4862,12 @@ export type ZoSubscriptionCreateInputV1InputContractKind = ("exact_event" | "gen
|
|
|
3628
4862
|
* account the handler runs as. Omit ``filter`` to receive every occurrence.
|
|
3629
4863
|
*/
|
|
3630
4864
|
export interface ZoSubscriptionCreateInputV1 {
|
|
4865
|
+
/**
|
|
4866
|
+
* @maxItems 100
|
|
4867
|
+
*
|
|
4868
|
+
* Items: A tag ID or name; unknown names are created, unknown IDs are refused.
|
|
4869
|
+
*/
|
|
4870
|
+
tags?: string[];
|
|
3631
4871
|
workspace_id: string;
|
|
3632
4872
|
event_id: string;
|
|
3633
4873
|
display_name: string;
|
|
@@ -3831,9 +5071,19 @@ export type ZoSubscriptionCreateInputV2InputContractKind = ("exact_event" | "gen
|
|
|
3831
5071
|
* occurrence.
|
|
3832
5072
|
*/
|
|
3833
5073
|
export interface ZoSubscriptionCreateInputV2 {
|
|
5074
|
+
/**
|
|
5075
|
+
* @maxItems 100
|
|
5076
|
+
*
|
|
5077
|
+
* Items: A tag ID or name; unknown names are created, unknown IDs are refused.
|
|
5078
|
+
*/
|
|
5079
|
+
tags?: string[];
|
|
3834
5080
|
workspace_id: string;
|
|
3835
5081
|
event_id: string;
|
|
3836
5082
|
display_name: string;
|
|
5083
|
+
/**
|
|
5084
|
+
* Describe what this subscription is for in the user's terms.
|
|
5085
|
+
*/
|
|
5086
|
+
description?: string;
|
|
3837
5087
|
filter?: ((ZoSubscriptionCreateInputV2EqFilter | ZoSubscriptionCreateInputV2InFilter | ZoSubscriptionCreateInputV2ExistsFilter | ZoSubscriptionCreateInputV2All1 | ZoSubscriptionCreateInputV2Any1) | null);
|
|
3838
5088
|
handler_resource_type: ("function" | "workflow" | "agent");
|
|
3839
5089
|
handler_resource_id?: (string | null);
|
|
@@ -3940,6 +5190,7 @@ export interface ZoSubscriptionCreateOutputV2 {
|
|
|
3940
5190
|
type: "event_subscription";
|
|
3941
5191
|
type_version: number;
|
|
3942
5192
|
display_name: string;
|
|
5193
|
+
description: string;
|
|
3943
5194
|
revision: number;
|
|
3944
5195
|
properties: ZoSubscriptionCreateOutputV2EventSubscriptionProperties;
|
|
3945
5196
|
event_type: string;
|
|
@@ -4213,6 +5464,7 @@ export interface ZoSubscriptionGetOutputV2 {
|
|
|
4213
5464
|
type: "event_subscription";
|
|
4214
5465
|
type_version: number;
|
|
4215
5466
|
display_name: string;
|
|
5467
|
+
description: string;
|
|
4216
5468
|
revision: number;
|
|
4217
5469
|
properties: ZoSubscriptionGetOutputV2EventSubscriptionProperties;
|
|
4218
5470
|
event_type: string;
|
|
@@ -4516,6 +5768,7 @@ export interface ZoSubscriptionListOutputV2SubscriptionResourceV2 {
|
|
|
4516
5768
|
type: "event_subscription";
|
|
4517
5769
|
type_version: number;
|
|
4518
5770
|
display_name: string;
|
|
5771
|
+
description: string;
|
|
4519
5772
|
revision: number;
|
|
4520
5773
|
properties: ZoSubscriptionListOutputV2EventSubscriptionProperties;
|
|
4521
5774
|
event_type: string;
|
|
@@ -4834,8 +6087,9 @@ export interface ZoSubscriptionUpdateOutputV1PrincipalRef {
|
|
|
4834
6087
|
}
|
|
4835
6088
|
export type ZoSubscriptionUpdateInputV2InputContractKind = ("exact_event" | "generic_envelope");
|
|
4836
6089
|
/**
|
|
4837
|
-
*
|
|
4838
|
-
* definition or version
|
|
6090
|
+
* Replace create fields except workspace, event and optional description.
|
|
6091
|
+
* A new event definition or version requires a new subscription.
|
|
6092
|
+
* Omitted or null description keeps its value. ``lifecycle``: ``active``
|
|
4839
6093
|
* resumes a paused or suspended subscription, ``paused`` pauses it;
|
|
4840
6094
|
* ``zo.subscription.delete`` retires. ``handler_resource_type`` must be the
|
|
4841
6095
|
* subscription's own: a different handler type is a new subscription.
|
|
@@ -4844,6 +6098,10 @@ export interface ZoSubscriptionUpdateInputV2 {
|
|
|
4844
6098
|
subscription_id: string;
|
|
4845
6099
|
expected_revision: number;
|
|
4846
6100
|
display_name: string;
|
|
6101
|
+
/**
|
|
6102
|
+
* Describe what this subscription is for in the user's terms.
|
|
6103
|
+
*/
|
|
6104
|
+
description?: (string | null);
|
|
4847
6105
|
filter?: ((ZoSubscriptionUpdateInputV2EqFilter | ZoSubscriptionUpdateInputV2InFilter | ZoSubscriptionUpdateInputV2ExistsFilter | ZoSubscriptionUpdateInputV2All1 | ZoSubscriptionUpdateInputV2Any1) | null);
|
|
4848
6106
|
handler_resource_type: ("function" | "workflow" | "agent");
|
|
4849
6107
|
handler_resource_id?: (string | null);
|
|
@@ -4950,6 +6208,7 @@ export interface ZoSubscriptionUpdateOutputV2 {
|
|
|
4950
6208
|
type: "event_subscription";
|
|
4951
6209
|
type_version: number;
|
|
4952
6210
|
display_name: string;
|
|
6211
|
+
description: string;
|
|
4953
6212
|
revision: number;
|
|
4954
6213
|
properties: ZoSubscriptionUpdateOutputV2EventSubscriptionProperties;
|
|
4955
6214
|
event_type: string;
|
|
@@ -5053,7 +6312,12 @@ export interface ZoSubscriptionUpdateOutputV2PrincipalRef {
|
|
|
5053
6312
|
}
|
|
5054
6313
|
export interface ZoTagAssignInputV1 {
|
|
5055
6314
|
workspace_id: string;
|
|
5056
|
-
target
|
|
6315
|
+
target?: ZoTagAssignInputV1TargetRef;
|
|
6316
|
+
/**
|
|
6317
|
+
* @minItems 1
|
|
6318
|
+
* @maxItems 200
|
|
6319
|
+
*/
|
|
6320
|
+
targets?: [ZoTagAssignInputV1TargetRef, ...(ZoTagAssignInputV1TargetRef)[]];
|
|
5057
6321
|
/**
|
|
5058
6322
|
* Tags by ID or name.
|
|
5059
6323
|
*
|
|
@@ -5066,7 +6330,7 @@ export interface ZoTagAssignInputV1 {
|
|
|
5066
6330
|
}
|
|
5067
6331
|
export interface ZoTagAssignInputV1TargetRef {
|
|
5068
6332
|
/**
|
|
5069
|
-
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database or file.
|
|
6333
|
+
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database, function, workflow, machine_image, vault or file.
|
|
5070
6334
|
*/
|
|
5071
6335
|
kind: string;
|
|
5072
6336
|
/**
|
|
@@ -5075,15 +6339,19 @@ export interface ZoTagAssignInputV1TargetRef {
|
|
|
5075
6339
|
id: string;
|
|
5076
6340
|
}
|
|
5077
6341
|
export interface ZoTagAssignOutputV1 {
|
|
5078
|
-
target: ZoTagAssignOutputV1TargetRef;
|
|
5079
6342
|
/**
|
|
5080
|
-
*
|
|
6343
|
+
* @minItems 1
|
|
6344
|
+
* @maxItems 200
|
|
5081
6345
|
*/
|
|
5082
|
-
|
|
6346
|
+
objects: [ZoTagAssignOutputV1ObjectChanges, ...(ZoTagAssignOutputV1ObjectChanges)[]];
|
|
6347
|
+
}
|
|
6348
|
+
export interface ZoTagAssignOutputV1ObjectChanges {
|
|
6349
|
+
target: ZoTagAssignOutputV1TargetRef;
|
|
6350
|
+
changed: number;
|
|
5083
6351
|
}
|
|
5084
6352
|
export interface ZoTagAssignOutputV1TargetRef {
|
|
5085
6353
|
/**
|
|
5086
|
-
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database or file.
|
|
6354
|
+
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database, function, workflow, machine_image, vault or file.
|
|
5087
6355
|
*/
|
|
5088
6356
|
kind: string;
|
|
5089
6357
|
/**
|
|
@@ -5091,13 +6359,6 @@ export interface ZoTagAssignOutputV1TargetRef {
|
|
|
5091
6359
|
*/
|
|
5092
6360
|
id: string;
|
|
5093
6361
|
}
|
|
5094
|
-
export interface ZoTagAssignOutputV1TagView {
|
|
5095
|
-
id: string;
|
|
5096
|
-
/**
|
|
5097
|
-
* The tag's name, spelled as first written.
|
|
5098
|
-
*/
|
|
5099
|
-
name: string;
|
|
5100
|
-
}
|
|
5101
6362
|
export interface ZoTagDeleteInputV1 {
|
|
5102
6363
|
workspace_id: string;
|
|
5103
6364
|
/**
|
|
@@ -5150,7 +6411,7 @@ export interface ZoTagItemsQueryV1 {
|
|
|
5150
6411
|
cursor?: string;
|
|
5151
6412
|
filter?: {
|
|
5152
6413
|
/**
|
|
5153
|
-
* Only objects of these kinds (task, agent, schedule, website, connection, event, event_subscription, machine, database or file).
|
|
6414
|
+
* Only objects of these kinds (task, agent, schedule, website, connection, event, event_subscription, machine, database, function, workflow, machine_image, vault or file).
|
|
5154
6415
|
*/
|
|
5155
6416
|
kinds?: ([string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | null);
|
|
5156
6417
|
};
|
|
@@ -5198,7 +6459,7 @@ export interface ZoTagOfInputV1 {
|
|
|
5198
6459
|
}
|
|
5199
6460
|
export interface ZoTagOfInputV1TargetRef {
|
|
5200
6461
|
/**
|
|
5201
|
-
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database or file.
|
|
6462
|
+
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database, function, workflow, machine_image, vault or file.
|
|
5202
6463
|
*/
|
|
5203
6464
|
kind: string;
|
|
5204
6465
|
/**
|
|
@@ -5221,7 +6482,7 @@ export interface ZoTagOfOutputV1ObjectTags {
|
|
|
5221
6482
|
}
|
|
5222
6483
|
export interface ZoTagOfOutputV1TargetRef {
|
|
5223
6484
|
/**
|
|
5224
|
-
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database or file.
|
|
6485
|
+
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database, function, workflow, machine_image, vault or file.
|
|
5225
6486
|
*/
|
|
5226
6487
|
kind: string;
|
|
5227
6488
|
/**
|
|
@@ -5256,7 +6517,12 @@ export interface ZoTagRenameOutputV1 {
|
|
|
5256
6517
|
}
|
|
5257
6518
|
export interface ZoTagUnassignInputV1 {
|
|
5258
6519
|
workspace_id: string;
|
|
5259
|
-
target
|
|
6520
|
+
target?: ZoTagUnassignInputV1TargetRef;
|
|
6521
|
+
/**
|
|
6522
|
+
* @minItems 1
|
|
6523
|
+
* @maxItems 200
|
|
6524
|
+
*/
|
|
6525
|
+
targets?: [ZoTagUnassignInputV1TargetRef, ...(ZoTagUnassignInputV1TargetRef)[]];
|
|
5260
6526
|
/**
|
|
5261
6527
|
* Tags by ID or name.
|
|
5262
6528
|
*
|
|
@@ -5269,7 +6535,7 @@ export interface ZoTagUnassignInputV1 {
|
|
|
5269
6535
|
}
|
|
5270
6536
|
export interface ZoTagUnassignInputV1TargetRef {
|
|
5271
6537
|
/**
|
|
5272
|
-
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database or file.
|
|
6538
|
+
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database, function, workflow, machine_image, vault or file.
|
|
5273
6539
|
*/
|
|
5274
6540
|
kind: string;
|
|
5275
6541
|
/**
|
|
@@ -5278,15 +6544,19 @@ export interface ZoTagUnassignInputV1TargetRef {
|
|
|
5278
6544
|
id: string;
|
|
5279
6545
|
}
|
|
5280
6546
|
export interface ZoTagUnassignOutputV1 {
|
|
5281
|
-
target: ZoTagUnassignOutputV1TargetRef;
|
|
5282
6547
|
/**
|
|
5283
|
-
*
|
|
6548
|
+
* @minItems 1
|
|
6549
|
+
* @maxItems 200
|
|
5284
6550
|
*/
|
|
5285
|
-
|
|
6551
|
+
objects: [ZoTagUnassignOutputV1ObjectChanges, ...(ZoTagUnassignOutputV1ObjectChanges)[]];
|
|
6552
|
+
}
|
|
6553
|
+
export interface ZoTagUnassignOutputV1ObjectChanges {
|
|
6554
|
+
target: ZoTagUnassignOutputV1TargetRef;
|
|
6555
|
+
changed: number;
|
|
5286
6556
|
}
|
|
5287
6557
|
export interface ZoTagUnassignOutputV1TargetRef {
|
|
5288
6558
|
/**
|
|
5289
|
-
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database or file.
|
|
6559
|
+
* The object's kind: task, agent, schedule, website, connection, event, event_subscription, machine, database, function, workflow, machine_image, vault or file.
|
|
5290
6560
|
*/
|
|
5291
6561
|
kind: string;
|
|
5292
6562
|
/**
|
|
@@ -5294,13 +6564,6 @@ export interface ZoTagUnassignOutputV1TargetRef {
|
|
|
5294
6564
|
*/
|
|
5295
6565
|
id: string;
|
|
5296
6566
|
}
|
|
5297
|
-
export interface ZoTagUnassignOutputV1TagView {
|
|
5298
|
-
id: string;
|
|
5299
|
-
/**
|
|
5300
|
-
* The tag's name, spelled as first written.
|
|
5301
|
-
*/
|
|
5302
|
-
name: string;
|
|
5303
|
-
}
|
|
5304
6567
|
export interface ZoTaskBlockerAddInputV1 {
|
|
5305
6568
|
workspace_id: string;
|
|
5306
6569
|
/**
|
|
@@ -5316,6 +6579,7 @@ export interface ZoTaskBlockerAddOutputV1 {
|
|
|
5316
6579
|
id: string;
|
|
5317
6580
|
workspace_id: string;
|
|
5318
6581
|
number: number;
|
|
6582
|
+
title: string;
|
|
5319
6583
|
status: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
5320
6584
|
assignee: (ZoTaskBlockerAddOutputV1PrincipalView | null);
|
|
5321
6585
|
/**
|
|
@@ -5384,6 +6648,7 @@ export interface ZoTaskBlockerAddOutputV1PrincipalView {
|
|
|
5384
6648
|
export interface ZoTaskBlockerAddOutputV1TaskLink {
|
|
5385
6649
|
id: string;
|
|
5386
6650
|
number: number;
|
|
6651
|
+
title: string;
|
|
5387
6652
|
status: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
5388
6653
|
}
|
|
5389
6654
|
export interface ZoTaskBlockerAddOutputV1TaskComment {
|
|
@@ -5422,6 +6687,7 @@ export interface ZoTaskBlockerRemoveOutputV1 {
|
|
|
5422
6687
|
id: string;
|
|
5423
6688
|
workspace_id: string;
|
|
5424
6689
|
number: number;
|
|
6690
|
+
title: string;
|
|
5425
6691
|
status: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
5426
6692
|
assignee: (ZoTaskBlockerRemoveOutputV1PrincipalView | null);
|
|
5427
6693
|
/**
|
|
@@ -5490,6 +6756,7 @@ export interface ZoTaskBlockerRemoveOutputV1PrincipalView {
|
|
|
5490
6756
|
export interface ZoTaskBlockerRemoveOutputV1TaskLink {
|
|
5491
6757
|
id: string;
|
|
5492
6758
|
number: number;
|
|
6759
|
+
title: string;
|
|
5493
6760
|
status: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
5494
6761
|
}
|
|
5495
6762
|
export interface ZoTaskBlockerRemoveOutputV1TaskComment {
|
|
@@ -5680,7 +6947,14 @@ export interface ZoTaskCommentUpdateOutputV1PrincipalView {
|
|
|
5680
6947
|
active: boolean;
|
|
5681
6948
|
}
|
|
5682
6949
|
export interface ZoTaskCreateInputV1 {
|
|
6950
|
+
/**
|
|
6951
|
+
* @maxItems 100
|
|
6952
|
+
*
|
|
6953
|
+
* Items: A tag ID or name; unknown names are created, unknown IDs are refused.
|
|
6954
|
+
*/
|
|
6955
|
+
tags?: string[];
|
|
5683
6956
|
workspace_id: string;
|
|
6957
|
+
title: string;
|
|
5684
6958
|
body?: string;
|
|
5685
6959
|
status?: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
5686
6960
|
assignee?: (ZoTaskCreateInputV1PrincipalInput | null);
|
|
@@ -5697,6 +6971,7 @@ export interface ZoTaskCreateOutputV1 {
|
|
|
5697
6971
|
id: string;
|
|
5698
6972
|
workspace_id: string;
|
|
5699
6973
|
number: number;
|
|
6974
|
+
title: string;
|
|
5700
6975
|
status: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
5701
6976
|
assignee: (ZoTaskCreateOutputV1PrincipalView | null);
|
|
5702
6977
|
/**
|
|
@@ -5765,6 +7040,7 @@ export interface ZoTaskCreateOutputV1PrincipalView {
|
|
|
5765
7040
|
export interface ZoTaskCreateOutputV1TaskLink {
|
|
5766
7041
|
id: string;
|
|
5767
7042
|
number: number;
|
|
7043
|
+
title: string;
|
|
5768
7044
|
status: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
5769
7045
|
}
|
|
5770
7046
|
export interface ZoTaskCreateOutputV1TaskComment {
|
|
@@ -5810,6 +7086,7 @@ export interface ZoTaskGetOutputV1 {
|
|
|
5810
7086
|
id: string;
|
|
5811
7087
|
workspace_id: string;
|
|
5812
7088
|
number: number;
|
|
7089
|
+
title: string;
|
|
5813
7090
|
status: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
5814
7091
|
assignee: (ZoTaskGetOutputV1PrincipalView | null);
|
|
5815
7092
|
/**
|
|
@@ -5878,6 +7155,7 @@ export interface ZoTaskGetOutputV1PrincipalView {
|
|
|
5878
7155
|
export interface ZoTaskGetOutputV1TaskLink {
|
|
5879
7156
|
id: string;
|
|
5880
7157
|
number: number;
|
|
7158
|
+
title: string;
|
|
5881
7159
|
status: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
5882
7160
|
}
|
|
5883
7161
|
export interface ZoTaskGetOutputV1TaskComment {
|
|
@@ -5916,6 +7194,7 @@ export interface ZoTaskListOutputV1TaskSummary {
|
|
|
5916
7194
|
id: string;
|
|
5917
7195
|
workspace_id: string;
|
|
5918
7196
|
number: number;
|
|
7197
|
+
title: string;
|
|
5919
7198
|
status: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
5920
7199
|
assignee: (ZoTaskListOutputV1PrincipalView | null);
|
|
5921
7200
|
/**
|
|
@@ -5984,6 +7263,7 @@ export interface ZoTaskUpdateInputV1 {
|
|
|
5984
7263
|
* The task's number ("42" or "#42") or its tsk_ ID.
|
|
5985
7264
|
*/
|
|
5986
7265
|
task: string;
|
|
7266
|
+
title?: (string | null);
|
|
5987
7267
|
body?: (string | null);
|
|
5988
7268
|
status?: (("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled") | null);
|
|
5989
7269
|
/**
|
|
@@ -6007,6 +7287,7 @@ export interface ZoTaskUpdateOutputV1 {
|
|
|
6007
7287
|
id: string;
|
|
6008
7288
|
workspace_id: string;
|
|
6009
7289
|
number: number;
|
|
7290
|
+
title: string;
|
|
6010
7291
|
status: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
6011
7292
|
assignee: (ZoTaskUpdateOutputV1PrincipalView | null);
|
|
6012
7293
|
/**
|
|
@@ -6075,6 +7356,7 @@ export interface ZoTaskUpdateOutputV1PrincipalView {
|
|
|
6075
7356
|
export interface ZoTaskUpdateOutputV1TaskLink {
|
|
6076
7357
|
id: string;
|
|
6077
7358
|
number: number;
|
|
7359
|
+
title: string;
|
|
6078
7360
|
status: ("backlog" | "ready" | "in_progress" | "failed" | "done" | "cancelled");
|
|
6079
7361
|
}
|
|
6080
7362
|
export interface ZoTaskUpdateOutputV1TaskComment {
|
|
@@ -6585,10 +7867,150 @@ export interface ZoVaultUpdateOutputV1RawFormat {
|
|
|
6585
7867
|
*/
|
|
6586
7868
|
type: "raw";
|
|
6587
7869
|
}
|
|
7870
|
+
export interface ZoWebFetchInputV1 {
|
|
7871
|
+
workspace_id: string;
|
|
7872
|
+
/**
|
|
7873
|
+
* The pages to read. A URL listed twice is read and charged once and returned at each position.
|
|
7874
|
+
*
|
|
7875
|
+
* @minItems 1
|
|
7876
|
+
* @maxItems 100
|
|
7877
|
+
*
|
|
7878
|
+
* Items: An http or https URL.
|
|
7879
|
+
*/
|
|
7880
|
+
urls: [string, ...(string)[]];
|
|
7881
|
+
/**
|
|
7882
|
+
* The most text to return per page. The response size limit can shorten pages further; a shortened page is marked truncated.
|
|
7883
|
+
*/
|
|
7884
|
+
max_characters?: number;
|
|
7885
|
+
/**
|
|
7886
|
+
* Fetch each page now instead of using a cached copy. Use it for prices, status pages and anything else that changes by the hour.
|
|
7887
|
+
*/
|
|
7888
|
+
live?: boolean;
|
|
7889
|
+
}
|
|
7890
|
+
export interface ZoWebFetchOutputV1 {
|
|
7891
|
+
/**
|
|
7892
|
+
* One entry per requested URL, in the order requested. A page that couldn't be read has status failed; the call still succeeds.
|
|
7893
|
+
*/
|
|
7894
|
+
pages: (ZoWebFetchOutputV1WebPage | ZoWebFetchOutputV1WebPageFailure)[];
|
|
7895
|
+
}
|
|
7896
|
+
export interface ZoWebFetchOutputV1WebPage {
|
|
7897
|
+
/**
|
|
7898
|
+
* The URL as requested.
|
|
7899
|
+
*/
|
|
7900
|
+
url: string;
|
|
7901
|
+
status: "ok";
|
|
7902
|
+
title: (string | null);
|
|
7903
|
+
/**
|
|
7904
|
+
* The page's estimated publication date, YYYY-MM-DD.
|
|
7905
|
+
*/
|
|
7906
|
+
published_date: (string | null);
|
|
7907
|
+
author: (string | null);
|
|
7908
|
+
/**
|
|
7909
|
+
* The page's main content as Markdown.
|
|
7910
|
+
*/
|
|
7911
|
+
text: string;
|
|
7912
|
+
/**
|
|
7913
|
+
* Whether the page had more text than was returned.
|
|
7914
|
+
*/
|
|
7915
|
+
truncated: boolean;
|
|
7916
|
+
}
|
|
7917
|
+
export interface ZoWebFetchOutputV1WebPageFailure {
|
|
7918
|
+
/**
|
|
7919
|
+
* The URL as requested.
|
|
7920
|
+
*/
|
|
7921
|
+
url: string;
|
|
7922
|
+
status: "failed";
|
|
7923
|
+
/**
|
|
7924
|
+
* not_found: the page doesn't exist. blocked: the site refused access. timeout: the page took too long to load. unsupported: the URL can't be read. unavailable: anything else; trying again later may work.
|
|
7925
|
+
*/
|
|
7926
|
+
error: ("not_found" | "blocked" | "timeout" | "unsupported" | "unavailable");
|
|
7927
|
+
}
|
|
7928
|
+
export interface ZoWebSearchInputV1 {
|
|
7929
|
+
workspace_id: string;
|
|
7930
|
+
/**
|
|
7931
|
+
* Describe the pages you want, as a sentence, rather than keywords. Restrict sites with include_domains, not site: in the query.
|
|
7932
|
+
*/
|
|
7933
|
+
query: string;
|
|
7934
|
+
/**
|
|
7935
|
+
* Goal for this search turn; say which documents should rank first, which should be excluded, and what specific facts or figures to pull from them.
|
|
7936
|
+
*/
|
|
7937
|
+
objective?: (string | null);
|
|
7938
|
+
/**
|
|
7939
|
+
* Focus on one kind of page. Omit for the general web. company and people can't take published dates; people can't take exclude_domains.
|
|
7940
|
+
*/
|
|
7941
|
+
category?: (("news" | "company" | "people" | "financial_report" | "publication" | "personal_site") | null);
|
|
7942
|
+
/**
|
|
7943
|
+
* How many results to return.
|
|
7944
|
+
*/
|
|
7945
|
+
num_results?: number;
|
|
7946
|
+
/**
|
|
7947
|
+
* Only return pages from these domains.
|
|
7948
|
+
*/
|
|
7949
|
+
include_domains?: (string[] | null);
|
|
7950
|
+
/**
|
|
7951
|
+
* Never return pages from these domains.
|
|
7952
|
+
*/
|
|
7953
|
+
exclude_domains?: (string[] | null);
|
|
7954
|
+
/**
|
|
7955
|
+
* Only pages published on or after the start of this day, UTC.
|
|
7956
|
+
*/
|
|
7957
|
+
published_after?: (string | null);
|
|
7958
|
+
/**
|
|
7959
|
+
* Only pages published before the start of this day, UTC.
|
|
7960
|
+
*/
|
|
7961
|
+
published_before?: (string | null);
|
|
7962
|
+
}
|
|
7963
|
+
export interface ZoWebSearchOutputV1 {
|
|
7964
|
+
/**
|
|
7965
|
+
* Ranked pages, best first.
|
|
7966
|
+
*/
|
|
7967
|
+
results: ZoWebSearchOutputV1WebSearchHit[];
|
|
7968
|
+
/**
|
|
7969
|
+
* Notes on how the results were produced, such as a restriction in the query that was relaxed because it matched nothing. Omitted when there are none.
|
|
7970
|
+
*/
|
|
7971
|
+
notices?: (ZoWebSearchOutputV1WebNotice[] | null);
|
|
7972
|
+
}
|
|
7973
|
+
export interface ZoWebSearchOutputV1WebSearchHit {
|
|
7974
|
+
url: string;
|
|
7975
|
+
title: (string | null);
|
|
7976
|
+
/**
|
|
7977
|
+
* The page's estimated publication date, YYYY-MM-DD.
|
|
7978
|
+
*/
|
|
7979
|
+
published_date: (string | null);
|
|
7980
|
+
author: (string | null);
|
|
7981
|
+
/**
|
|
7982
|
+
* The passages most relevant to the query.
|
|
7983
|
+
*/
|
|
7984
|
+
highlights: string[];
|
|
7985
|
+
}
|
|
7986
|
+
export interface ZoWebSearchOutputV1WebNotice {
|
|
7987
|
+
/**
|
|
7988
|
+
* An open set of codes, such as RESTRICTIONS_RELAXED.
|
|
7989
|
+
*/
|
|
7990
|
+
code: string;
|
|
7991
|
+
/**
|
|
7992
|
+
* What the notice means, written for a model reading the results.
|
|
7993
|
+
*/
|
|
7994
|
+
message: string;
|
|
7995
|
+
/**
|
|
7996
|
+
* The input field the notice is about, as a JSON Pointer.
|
|
7997
|
+
*/
|
|
7998
|
+
path?: (string | null);
|
|
7999
|
+
}
|
|
6588
8000
|
export interface ZoWebsiteCreateInputV1 {
|
|
8001
|
+
/**
|
|
8002
|
+
* @maxItems 100
|
|
8003
|
+
*
|
|
8004
|
+
* Items: A tag ID or name; unknown names are created, unknown IDs are refused.
|
|
8005
|
+
*/
|
|
8006
|
+
tags?: string[];
|
|
6589
8007
|
workspace_id: string;
|
|
6590
8008
|
slug: string;
|
|
6591
8009
|
display_name: string;
|
|
8010
|
+
/**
|
|
8011
|
+
* Describe what this Website is for in the user's terms.
|
|
8012
|
+
*/
|
|
8013
|
+
description?: string;
|
|
6592
8014
|
visibility?: ("workspace" | "protected");
|
|
6593
8015
|
}
|
|
6594
8016
|
export interface ZoWebsiteCreateOutputV1 {
|
|
@@ -6596,6 +8018,7 @@ export interface ZoWebsiteCreateOutputV1 {
|
|
|
6596
8018
|
workspace_id: string;
|
|
6597
8019
|
slug: string;
|
|
6598
8020
|
display_name: string;
|
|
8021
|
+
description: string;
|
|
6599
8022
|
generated_hostname: string;
|
|
6600
8023
|
custom_hostname: (ZoWebsiteCreateOutputV1WebsiteHostname | null);
|
|
6601
8024
|
access: "public";
|
|
@@ -6625,6 +8048,7 @@ export interface ZoWebsiteGetOutputV1 {
|
|
|
6625
8048
|
workspace_id: string;
|
|
6626
8049
|
slug: string;
|
|
6627
8050
|
display_name: string;
|
|
8051
|
+
description: string;
|
|
6628
8052
|
generated_hostname: string;
|
|
6629
8053
|
custom_hostname: (ZoWebsiteGetOutputV1WebsiteHostname | null);
|
|
6630
8054
|
access: "public";
|
|
@@ -6650,6 +8074,7 @@ export interface ZoWebsiteListOutputV1WebsiteListItem {
|
|
|
6650
8074
|
workspace_id: string;
|
|
6651
8075
|
slug: string;
|
|
6652
8076
|
display_name: string;
|
|
8077
|
+
description: string;
|
|
6653
8078
|
generated_hostname: string;
|
|
6654
8079
|
custom_hostname: (ZoWebsiteListOutputV1WebsiteHostname | null);
|
|
6655
8080
|
access: "public";
|
|
@@ -6711,6 +8136,10 @@ export interface ZoWebsiteUpdateInputV1 {
|
|
|
6711
8136
|
website_id: string;
|
|
6712
8137
|
expected_revision: number;
|
|
6713
8138
|
display_name?: (string | null);
|
|
8139
|
+
/**
|
|
8140
|
+
* Describe what this Website is for in the user's terms.
|
|
8141
|
+
*/
|
|
8142
|
+
description?: (string | null);
|
|
6714
8143
|
custom_hostname?: (ZoWebsiteUpdateInputV1CustomHostnameChange | null);
|
|
6715
8144
|
}
|
|
6716
8145
|
export interface ZoWebsiteUpdateInputV1CustomHostnameChange {
|
|
@@ -6721,6 +8150,7 @@ export interface ZoWebsiteUpdateOutputV1 {
|
|
|
6721
8150
|
workspace_id: string;
|
|
6722
8151
|
slug: string;
|
|
6723
8152
|
display_name: string;
|
|
8153
|
+
description: string;
|
|
6724
8154
|
generated_hostname: string;
|
|
6725
8155
|
custom_hostname: (ZoWebsiteUpdateOutputV1WebsiteHostname | null);
|
|
6726
8156
|
access: "public";
|
|
@@ -7058,6 +8488,10 @@ export interface ZoWorkflowCancelRunOutputV1 {
|
|
|
7058
8488
|
export interface ZoWorkflowCreateInputV1 {
|
|
7059
8489
|
workspace_id: string;
|
|
7060
8490
|
display_name: string;
|
|
8491
|
+
/**
|
|
8492
|
+
* Describe what this workflow is for in the user's terms.
|
|
8493
|
+
*/
|
|
8494
|
+
description?: string;
|
|
7061
8495
|
visibility?: ("workspace" | "protected");
|
|
7062
8496
|
}
|
|
7063
8497
|
export interface ZoWorkflowCreateOutputV1 {
|
|
@@ -7066,6 +8500,7 @@ export interface ZoWorkflowCreateOutputV1 {
|
|
|
7066
8500
|
type: "workflow";
|
|
7067
8501
|
type_version: number;
|
|
7068
8502
|
display_name: string;
|
|
8503
|
+
description: string;
|
|
7069
8504
|
revision: number;
|
|
7070
8505
|
active_revision_id: (string | null);
|
|
7071
8506
|
latest_revision_id: (string | null);
|
|
@@ -7090,6 +8525,7 @@ export interface ZoWorkflowGetOutputV1 {
|
|
|
7090
8525
|
type: "workflow";
|
|
7091
8526
|
type_version: number;
|
|
7092
8527
|
display_name: string;
|
|
8528
|
+
description: string;
|
|
7093
8529
|
revision: number;
|
|
7094
8530
|
active_revision_id: (string | null);
|
|
7095
8531
|
latest_revision_id: (string | null);
|
|
@@ -7167,6 +8603,7 @@ export interface ZoWorkflowListOutputV1VisibleWorkflowResource {
|
|
|
7167
8603
|
type: "workflow";
|
|
7168
8604
|
type_version: number;
|
|
7169
8605
|
display_name: string;
|
|
8606
|
+
description: string;
|
|
7170
8607
|
revision: number;
|
|
7171
8608
|
active_revision_id: (string | null);
|
|
7172
8609
|
latest_revision_id: (string | null);
|
|
@@ -7244,6 +8681,29 @@ export interface ZoWorkflowRevisionGetOutputV1 {
|
|
|
7244
8681
|
status: ZoWorkflowRevisionGetOutputV1RevisionStatus;
|
|
7245
8682
|
error_code: (string | null);
|
|
7246
8683
|
}
|
|
8684
|
+
export interface ZoWorkflowUpdateInputV1 {
|
|
8685
|
+
workflow_id: string;
|
|
8686
|
+
expected_revision: number;
|
|
8687
|
+
display_name?: (string | null);
|
|
8688
|
+
/**
|
|
8689
|
+
* Omitted or null keeps the description; "" clears it.
|
|
8690
|
+
*/
|
|
8691
|
+
description?: (string | null);
|
|
8692
|
+
}
|
|
8693
|
+
export interface ZoWorkflowUpdateOutputV1 {
|
|
8694
|
+
id: string;
|
|
8695
|
+
workspace_id: string;
|
|
8696
|
+
type: "workflow";
|
|
8697
|
+
type_version: number;
|
|
8698
|
+
display_name: string;
|
|
8699
|
+
description: string;
|
|
8700
|
+
revision: number;
|
|
8701
|
+
active_revision_id: (string | null);
|
|
8702
|
+
latest_revision_id: (string | null);
|
|
8703
|
+
created_at: string;
|
|
8704
|
+
visibility: ("workspace" | "protected");
|
|
8705
|
+
owner_user_id: (string | null);
|
|
8706
|
+
}
|
|
7247
8707
|
export interface ZoWorkspaceGetInputV1 {
|
|
7248
8708
|
workspace_id: string;
|
|
7249
8709
|
}
|
|
@@ -7341,6 +8801,7 @@ export interface EventSubscriptionV1 {
|
|
|
7341
8801
|
export interface FunctionV1 {
|
|
7342
8802
|
code_owner: ("zo" | "workspace");
|
|
7343
8803
|
}
|
|
8804
|
+
export type MachineV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
7344
8805
|
/**
|
|
7345
8806
|
* Public properties of a `machine` resource.
|
|
7346
8807
|
*
|
|
@@ -7358,11 +8819,63 @@ export interface MachineV1 {
|
|
|
7358
8819
|
machine_image_id: (string | null);
|
|
7359
8820
|
vcpus: (number | null);
|
|
7360
8821
|
memory_mib: (number | null);
|
|
8822
|
+
gpu?: (MachineV1MachineGpu | null);
|
|
7361
8823
|
region: (string | null);
|
|
7362
8824
|
idle_timeout_seconds: (number | null);
|
|
7363
8825
|
max_run_seconds: (number | null);
|
|
7364
8826
|
init?: (("none" | "image") | null);
|
|
7365
8827
|
command?: ([string, ...(string)[]] | null);
|
|
8828
|
+
environment?: ({
|
|
8829
|
+
[k: string]: string;
|
|
8830
|
+
} | null);
|
|
8831
|
+
credentials?: (string[] | null);
|
|
8832
|
+
outbound_network_policies?: (MachineV1OutboundNetworkPolicy[] | null);
|
|
8833
|
+
}
|
|
8834
|
+
export interface MachineV1MachineGpu {
|
|
8835
|
+
type: MachineV1GpuType;
|
|
8836
|
+
count: number;
|
|
8837
|
+
}
|
|
8838
|
+
/**
|
|
8839
|
+
* Send one slot's credential as a header on HTTPS requests to some hosts.
|
|
8840
|
+
*/
|
|
8841
|
+
export interface MachineV1OutboundNetworkPolicy {
|
|
8842
|
+
/**
|
|
8843
|
+
* The connection ID.
|
|
8844
|
+
*/
|
|
8845
|
+
credential: string;
|
|
8846
|
+
/**
|
|
8847
|
+
* The connection definition's slot, by name.
|
|
8848
|
+
*/
|
|
8849
|
+
slot: string;
|
|
8850
|
+
hosts?: ([string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string] | null);
|
|
8851
|
+
location?: (MachineV1HeaderLocation | null);
|
|
8852
|
+
format?: ((MachineV1BearerFormat | MachineV1BasicFormat | MachineV1RawFormat) | null);
|
|
8853
|
+
}
|
|
8854
|
+
export interface MachineV1HeaderLocation {
|
|
8855
|
+
type: "header";
|
|
8856
|
+
/**
|
|
8857
|
+
* The header to set, such as `Authorization` or `X-API-Key`.
|
|
8858
|
+
*/
|
|
8859
|
+
name: string;
|
|
8860
|
+
}
|
|
8861
|
+
export interface MachineV1BearerFormat {
|
|
8862
|
+
/**
|
|
8863
|
+
* `Bearer <value>`.
|
|
8864
|
+
*/
|
|
8865
|
+
type: "bearer";
|
|
8866
|
+
}
|
|
8867
|
+
export interface MachineV1BasicFormat {
|
|
8868
|
+
/**
|
|
8869
|
+
* `Basic` with base64 of `<username>:<value>`.
|
|
8870
|
+
*/
|
|
8871
|
+
type: "basic";
|
|
8872
|
+
username: string;
|
|
8873
|
+
}
|
|
8874
|
+
export interface MachineV1RawFormat {
|
|
8875
|
+
/**
|
|
8876
|
+
* The value as it is.
|
|
8877
|
+
*/
|
|
8878
|
+
type: "raw";
|
|
7366
8879
|
}
|
|
7367
8880
|
export type MachineImageV1ImageOrigin = ("registry" | "build" | "machine_snapshot");
|
|
7368
8881
|
/**
|
|
@@ -7496,6 +9009,27 @@ export type Operations = {
|
|
|
7496
9009
|
query: ZoAgentSessionListWorkspaceQueryV1;
|
|
7497
9010
|
};
|
|
7498
9011
|
};
|
|
9012
|
+
"zo.billing.list_rates": {
|
|
9013
|
+
1: {
|
|
9014
|
+
input: ZoBillingListRatesInputV1;
|
|
9015
|
+
output: ZoBillingListRatesOutputV1;
|
|
9016
|
+
query: ZoBillingListRatesQueryV1;
|
|
9017
|
+
};
|
|
9018
|
+
};
|
|
9019
|
+
"zo.billing.list_usage_entries": {
|
|
9020
|
+
1: {
|
|
9021
|
+
input: ZoBillingListUsageEntriesInputV1;
|
|
9022
|
+
output: ZoBillingListUsageEntriesOutputV1;
|
|
9023
|
+
query: ZoBillingListUsageEntriesQueryV1;
|
|
9024
|
+
};
|
|
9025
|
+
};
|
|
9026
|
+
"zo.billing.summarize_usage": {
|
|
9027
|
+
1: {
|
|
9028
|
+
input: ZoBillingSummarizeUsageInputV1;
|
|
9029
|
+
output: ZoBillingSummarizeUsageOutputV1;
|
|
9030
|
+
query: ZoBillingSummarizeUsageQueryV1;
|
|
9031
|
+
};
|
|
9032
|
+
};
|
|
7499
9033
|
"zo.connection.authorize": {
|
|
7500
9034
|
1: {
|
|
7501
9035
|
input: ZoConnectionAuthorizeInputV1;
|
|
@@ -7750,6 +9284,12 @@ export type Operations = {
|
|
|
7750
9284
|
output: ZoFunctionPublishContractOutputV1;
|
|
7751
9285
|
};
|
|
7752
9286
|
};
|
|
9287
|
+
"zo.function.update": {
|
|
9288
|
+
1: {
|
|
9289
|
+
input: ZoFunctionUpdateInputV1;
|
|
9290
|
+
output: ZoFunctionUpdateOutputV1;
|
|
9291
|
+
};
|
|
9292
|
+
};
|
|
7753
9293
|
"zo.machine.apply_patch": {
|
|
7754
9294
|
1: {
|
|
7755
9295
|
input: ZoMachineApplyPatchInputV1;
|
|
@@ -7867,6 +9407,12 @@ export type Operations = {
|
|
|
7867
9407
|
query: ZoMachineImageListQueryV1;
|
|
7868
9408
|
};
|
|
7869
9409
|
};
|
|
9410
|
+
"zo.machine_image.update": {
|
|
9411
|
+
1: {
|
|
9412
|
+
input: ZoMachineImageUpdateInputV1;
|
|
9413
|
+
output: ZoMachineImageUpdateOutputV1;
|
|
9414
|
+
};
|
|
9415
|
+
};
|
|
7870
9416
|
"zo.message.get": {
|
|
7871
9417
|
1: {
|
|
7872
9418
|
input: ZoMessageGetInputV1;
|
|
@@ -7904,6 +9450,19 @@ export type Operations = {
|
|
|
7904
9450
|
output: ZoOauthAppUpdateOutputV1;
|
|
7905
9451
|
};
|
|
7906
9452
|
};
|
|
9453
|
+
"zo.quota.get": {
|
|
9454
|
+
1: {
|
|
9455
|
+
input: ZoQuotaGetInputV1;
|
|
9456
|
+
output: ZoQuotaGetOutputV1;
|
|
9457
|
+
};
|
|
9458
|
+
};
|
|
9459
|
+
"zo.quota.list": {
|
|
9460
|
+
1: {
|
|
9461
|
+
input: ZoQuotaListInputV1;
|
|
9462
|
+
output: ZoQuotaListOutputV1;
|
|
9463
|
+
query: ZoQuotaListQueryV1;
|
|
9464
|
+
};
|
|
9465
|
+
};
|
|
7907
9466
|
"zo.schedule.create": {
|
|
7908
9467
|
1: {
|
|
7909
9468
|
input: ZoScheduleCreateInputV1;
|
|
@@ -8150,6 +9709,18 @@ export type Operations = {
|
|
|
8150
9709
|
output: ZoVaultUpdateOutputV1;
|
|
8151
9710
|
};
|
|
8152
9711
|
};
|
|
9712
|
+
"zo.web.fetch": {
|
|
9713
|
+
1: {
|
|
9714
|
+
input: ZoWebFetchInputV1;
|
|
9715
|
+
output: ZoWebFetchOutputV1;
|
|
9716
|
+
};
|
|
9717
|
+
};
|
|
9718
|
+
"zo.web.search": {
|
|
9719
|
+
1: {
|
|
9720
|
+
input: ZoWebSearchInputV1;
|
|
9721
|
+
output: ZoWebSearchOutputV1;
|
|
9722
|
+
};
|
|
9723
|
+
};
|
|
8153
9724
|
"zo.website.create": {
|
|
8154
9725
|
1: {
|
|
8155
9726
|
input: ZoWebsiteCreateInputV1;
|
|
@@ -8292,6 +9863,12 @@ export type Operations = {
|
|
|
8292
9863
|
output: ZoWorkflowRevisionGetOutputV1;
|
|
8293
9864
|
};
|
|
8294
9865
|
};
|
|
9866
|
+
"zo.workflow.update": {
|
|
9867
|
+
1: {
|
|
9868
|
+
input: ZoWorkflowUpdateInputV1;
|
|
9869
|
+
output: ZoWorkflowUpdateOutputV1;
|
|
9870
|
+
};
|
|
9871
|
+
};
|
|
8295
9872
|
"zo.workspace.get": {
|
|
8296
9873
|
1: {
|
|
8297
9874
|
input: ZoWorkspaceGetInputV1;
|
|
@@ -8320,6 +9897,9 @@ export type DefaultVersions = {
|
|
|
8320
9897
|
"zo.agent_session.history": 1;
|
|
8321
9898
|
"zo.agent_session.list": 1;
|
|
8322
9899
|
"zo.agent_session.list_workspace": 1;
|
|
9900
|
+
"zo.billing.list_rates": 1;
|
|
9901
|
+
"zo.billing.list_usage_entries": 1;
|
|
9902
|
+
"zo.billing.summarize_usage": 1;
|
|
8323
9903
|
"zo.connection.authorize": 1;
|
|
8324
9904
|
"zo.connection.create": 1;
|
|
8325
9905
|
"zo.connection.delete": 1;
|
|
@@ -8360,6 +9940,7 @@ export type DefaultVersions = {
|
|
|
8360
9940
|
"zo.function.list": 1;
|
|
8361
9941
|
"zo.function.list_runs": 1;
|
|
8362
9942
|
"zo.function.publish_contract": 1;
|
|
9943
|
+
"zo.function.update": 1;
|
|
8363
9944
|
"zo.machine.apply_patch": 1;
|
|
8364
9945
|
"zo.machine.create": 1;
|
|
8365
9946
|
"zo.machine.destroy": 1;
|
|
@@ -8379,12 +9960,15 @@ export type DefaultVersions = {
|
|
|
8379
9960
|
"zo.machine_image.get": 1;
|
|
8380
9961
|
"zo.machine_image.import": 1;
|
|
8381
9962
|
"zo.machine_image.list": 1;
|
|
9963
|
+
"zo.machine_image.update": 1;
|
|
8382
9964
|
"zo.message.get": 1;
|
|
8383
9965
|
"zo.oauth_app.create": 1;
|
|
8384
9966
|
"zo.oauth_app.delete": 1;
|
|
8385
9967
|
"zo.oauth_app.get": 1;
|
|
8386
9968
|
"zo.oauth_app.list": 1;
|
|
8387
9969
|
"zo.oauth_app.update": 1;
|
|
9970
|
+
"zo.quota.get": 1;
|
|
9971
|
+
"zo.quota.list": 1;
|
|
8388
9972
|
"zo.schedule.create": 1;
|
|
8389
9973
|
"zo.schedule.delete": 1;
|
|
8390
9974
|
"zo.schedule.get": 1;
|
|
@@ -8422,6 +10006,8 @@ export type DefaultVersions = {
|
|
|
8422
10006
|
"zo.vault.list": 1;
|
|
8423
10007
|
"zo.vault.rotate": 1;
|
|
8424
10008
|
"zo.vault.update": 1;
|
|
10009
|
+
"zo.web.fetch": 1;
|
|
10010
|
+
"zo.web.search": 1;
|
|
8425
10011
|
"zo.website.create": 1;
|
|
8426
10012
|
"zo.website.delete": 1;
|
|
8427
10013
|
"zo.website.get": 1;
|
|
@@ -8445,6 +10031,7 @@ export type DefaultVersions = {
|
|
|
8445
10031
|
"zo.workflow.list_runs": 1;
|
|
8446
10032
|
"zo.workflow.publish": 1;
|
|
8447
10033
|
"zo.workflow.revision.get": 1;
|
|
10034
|
+
"zo.workflow.update": 1;
|
|
8448
10035
|
"zo.workspace.get": 1;
|
|
8449
10036
|
"zo.workspace.list_resources": 1;
|
|
8450
10037
|
};
|