@aignostics/sdk 3.6.1 → 3.8.0

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.
@@ -1,3296 +0,0 @@
1
- import * as axios from 'axios';
2
- import { RawAxiosRequestConfig, AxiosInstance, AxiosPromise } from 'axios';
3
-
4
- /**
5
- * Aignostics Platform API
6
- * The Aignostics Platform is a cloud-based service that enables organizations to access advanced computational pathology applications through a secure API. The platform provides standardized access to Aignostics\' portfolio of computational pathology solutions, with Atlas H&E-TME serving as an example of the available API endpoints. To begin using the platform, your organization must first be registered by our business support team. If you don\'t have an account yet, please contact your account manager or email support@aignostics.com to get started. More information about our applications can be found on [https://platform.aignostics.com](https://platform.aignostics.com). **How to authorize and test API endpoints:** 1. Click the \"Authorize\" button in the right corner below 3. Click \"Authorize\" button in the dialog to log in with your Aignostics Platform credentials 4. After successful login, you\'ll be redirected back and can use \"Try it out\" on any endpoint **Note**: You only need to authorize once per session. The lock icons next to endpoints will show green when authorized.
7
- *
8
- * The version of the OpenAPI document: 1.7.0
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- interface ConfigurationParameters {
16
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
17
- username?: string;
18
- password?: string;
19
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
20
- basePath?: string;
21
- serverIndex?: number;
22
- baseOptions?: any;
23
- formDataCtor?: new () => any;
24
- }
25
- declare class Configuration {
26
- /**
27
- * parameter for apiKey security
28
- * @param name security name
29
- * @memberof Configuration
30
- */
31
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
32
- /**
33
- * parameter for basic security
34
- *
35
- * @type {string}
36
- * @memberof Configuration
37
- */
38
- username?: string;
39
- /**
40
- * parameter for basic security
41
- *
42
- * @type {string}
43
- * @memberof Configuration
44
- */
45
- password?: string;
46
- /**
47
- * parameter for oauth2 security
48
- * @param name security name
49
- * @param scopes oauth2 scope
50
- * @memberof Configuration
51
- */
52
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
53
- /**
54
- * override base path
55
- *
56
- * @type {string}
57
- * @memberof Configuration
58
- */
59
- basePath?: string;
60
- /**
61
- * override server index
62
- *
63
- * @type {number}
64
- * @memberof Configuration
65
- */
66
- serverIndex?: number;
67
- /**
68
- * base options for axios calls
69
- *
70
- * @type {any}
71
- * @memberof Configuration
72
- */
73
- baseOptions?: any;
74
- /**
75
- * The FormData constructor that will be used to create multipart form data
76
- * requests. You can inject this here so that execution environments that
77
- * do not support the FormData class can still run the generated client.
78
- *
79
- * @type {new () => FormData}
80
- */
81
- formDataCtor?: new () => any;
82
- constructor(param?: ConfigurationParameters);
83
- /**
84
- * Check if the given MIME is a JSON MIME.
85
- * JSON MIME examples:
86
- * application/json
87
- * application/json; charset=UTF8
88
- * APPLICATION/JSON
89
- * application/vnd.company+json
90
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
91
- * @return True if the given MIME is JSON, false otherwise.
92
- */
93
- isJsonMime(mime: string): boolean;
94
- }
95
-
96
- /**
97
- * Aignostics Platform API
98
- * The Aignostics Platform is a cloud-based service that enables organizations to access advanced computational pathology applications through a secure API. The platform provides standardized access to Aignostics\' portfolio of computational pathology solutions, with Atlas H&E-TME serving as an example of the available API endpoints. To begin using the platform, your organization must first be registered by our business support team. If you don\'t have an account yet, please contact your account manager or email support@aignostics.com to get started. More information about our applications can be found on [https://platform.aignostics.com](https://platform.aignostics.com). **How to authorize and test API endpoints:** 1. Click the \"Authorize\" button in the right corner below 3. Click \"Authorize\" button in the dialog to log in with your Aignostics Platform credentials 4. After successful login, you\'ll be redirected back and can use \"Try it out\" on any endpoint **Note**: You only need to authorize once per session. The lock icons next to endpoints will show green when authorized.
99
- *
100
- * The version of the OpenAPI document: 1.7.0
101
- *
102
- *
103
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
104
- * https://openapi-generator.tech
105
- * Do not edit the class manually.
106
- */
107
-
108
- /**
109
- *
110
- * @export
111
- * @interface RequestArgs
112
- */
113
- interface RequestArgs {
114
- url: string;
115
- options: RawAxiosRequestConfig;
116
- }
117
- /**
118
- *
119
- * @export
120
- * @class BaseAPI
121
- */
122
- declare class BaseAPI {
123
- protected basePath: string;
124
- protected axios: AxiosInstance;
125
- protected configuration: Configuration | undefined;
126
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
127
- }
128
-
129
- /**
130
- * Response schema for `List available applications` and `Read Application by Id` endpoints
131
- * @export
132
- * @interface ApplicationReadResponse
133
- */
134
- interface ApplicationReadResponse {
135
- /**
136
- * Application ID
137
- * @type {string}
138
- * @memberof ApplicationReadResponse
139
- */
140
- 'application_id': string;
141
- /**
142
- * Application display name
143
- * @type {string}
144
- * @memberof ApplicationReadResponse
145
- */
146
- 'name': string;
147
- /**
148
- * Regulatory classes, to which the applications comply with. Possible values include: RUO, IVDR, FDA.
149
- * @type {Array<string>}
150
- * @memberof ApplicationReadResponse
151
- */
152
- 'regulatory_classes': Array<string>;
153
- /**
154
- * Describing what the application can do
155
- * @type {string}
156
- * @memberof ApplicationReadResponse
157
- */
158
- 'description': string;
159
- /**
160
- * All version numbers available to the user
161
- * @type {Array<ApplicationVersion>}
162
- * @memberof ApplicationReadResponse
163
- */
164
- 'versions': Array<ApplicationVersion>;
165
- }
166
- /**
167
- * Response schema for `List available applications` and `Read Application by Id` endpoints
168
- * @export
169
- * @interface ApplicationReadShortResponse
170
- */
171
- interface ApplicationReadShortResponse {
172
- /**
173
- * Application ID
174
- * @type {string}
175
- * @memberof ApplicationReadShortResponse
176
- */
177
- 'application_id': string;
178
- /**
179
- * Application display name
180
- * @type {string}
181
- * @memberof ApplicationReadShortResponse
182
- */
183
- 'name': string;
184
- /**
185
- * Regulatory classes, to which the applications comply with. Possible values include: RUO, IVDR, FDA.
186
- * @type {Array<string>}
187
- * @memberof ApplicationReadShortResponse
188
- */
189
- 'regulatory_classes': Array<string>;
190
- /**
191
- * Describing what the application can do
192
- * @type {string}
193
- * @memberof ApplicationReadShortResponse
194
- */
195
- 'description': string;
196
- /**
197
- *
198
- * @type {ApplicationVersion}
199
- * @memberof ApplicationReadShortResponse
200
- */
201
- 'latest_version'?: ApplicationVersion | null;
202
- }
203
- /**
204
- *
205
- * @export
206
- * @interface ApplicationVersion
207
- */
208
- interface ApplicationVersion {
209
- /**
210
- * The number of the latest version
211
- * @type {string}
212
- * @memberof ApplicationVersion
213
- */
214
- 'number': string;
215
- /**
216
- * The timestamp for when the application version was made available in the Platform
217
- * @type {string}
218
- * @memberof ApplicationVersion
219
- */
220
- 'released_at': string;
221
- }
222
- /**
223
- *
224
- * @export
225
- * @enum {string}
226
- */
227
- declare const ArtifactOutput: {
228
- readonly None: "NONE";
229
- readonly Available: "AVAILABLE";
230
- readonly DeletedByUser: "DELETED_BY_USER";
231
- readonly DeletedBySystem: "DELETED_BY_SYSTEM";
232
- };
233
- type ArtifactOutput = typeof ArtifactOutput[keyof typeof ArtifactOutput];
234
- /**
235
- *
236
- * @export
237
- * @enum {string}
238
- */
239
- declare const ArtifactState: {
240
- readonly Pending: "PENDING";
241
- readonly Processing: "PROCESSING";
242
- readonly Terminated: "TERMINATED";
243
- };
244
- type ArtifactState = typeof ArtifactState[keyof typeof ArtifactState];
245
- /**
246
- *
247
- * @export
248
- * @enum {string}
249
- */
250
- declare const ArtifactTerminationReason: {
251
- readonly Succeeded: "SUCCEEDED";
252
- readonly UserError: "USER_ERROR";
253
- readonly SystemError: "SYSTEM_ERROR";
254
- readonly Skipped: "SKIPPED";
255
- };
256
- type ArtifactTerminationReason = typeof ArtifactTerminationReason[keyof typeof ArtifactTerminationReason];
257
- /**
258
- *
259
- * @export
260
- * @interface CustomMetadataUpdateRequest
261
- */
262
- interface CustomMetadataUpdateRequest {
263
- /**
264
- *
265
- * @type {{ [key: string]: any; }}
266
- * @memberof CustomMetadataUpdateRequest
267
- */
268
- 'custom_metadata'?: {
269
- [key: string]: any;
270
- } | null;
271
- /**
272
- *
273
- * @type {string}
274
- * @memberof CustomMetadataUpdateRequest
275
- */
276
- 'custom_metadata_checksum'?: string | null;
277
- }
278
- /**
279
- *
280
- * @export
281
- * @interface CustomMetadataUpdateResponse
282
- */
283
- interface CustomMetadataUpdateResponse {
284
- /**
285
- *
286
- * @type {string}
287
- * @memberof CustomMetadataUpdateResponse
288
- */
289
- 'custom_metadata_checksum': string | null;
290
- }
291
- /**
292
- *
293
- * @export
294
- * @interface GrantCreateRequest
295
- */
296
- interface GrantCreateRequest {
297
- /**
298
- *
299
- * @type {ResourceType}
300
- * @memberof GrantCreateRequest
301
- */
302
- 'resource_type': ResourceType;
303
- /**
304
- *
305
- * @type {string}
306
- * @memberof GrantCreateRequest
307
- */
308
- 'resource_id': string;
309
- /**
310
- *
311
- * @type {SubjectType}
312
- * @memberof GrantCreateRequest
313
- */
314
- 'subject_type': SubjectType;
315
- /**
316
- *
317
- * @type {string}
318
- * @memberof GrantCreateRequest
319
- */
320
- 'subject_id'?: string | null;
321
- /**
322
- *
323
- * @type {string}
324
- * @memberof GrantCreateRequest
325
- */
326
- 'subject_email'?: string | null;
327
- /**
328
- *
329
- * @type {GrantRelation}
330
- * @memberof GrantCreateRequest
331
- */
332
- 'relation': GrantRelation;
333
- }
334
- /**
335
- *
336
- * @export
337
- * @interface GrantReadResponse
338
- */
339
- interface GrantReadResponse {
340
- /**
341
- *
342
- * @type {string}
343
- * @memberof GrantReadResponse
344
- */
345
- 'grant_id': string;
346
- /**
347
- *
348
- * @type {ResourceType}
349
- * @memberof GrantReadResponse
350
- */
351
- 'resource_type': ResourceType;
352
- /**
353
- *
354
- * @type {string}
355
- * @memberof GrantReadResponse
356
- */
357
- 'resource_id': string;
358
- /**
359
- *
360
- * @type {SubjectType}
361
- * @memberof GrantReadResponse
362
- */
363
- 'subject_type': SubjectType;
364
- /**
365
- *
366
- * @type {string}
367
- * @memberof GrantReadResponse
368
- */
369
- 'subject_id': string;
370
- /**
371
- *
372
- * @type {GrantRelation}
373
- * @memberof GrantReadResponse
374
- */
375
- 'relation': GrantRelation;
376
- /**
377
- *
378
- * @type {string}
379
- * @memberof GrantReadResponse
380
- */
381
- 'created_by': string;
382
- /**
383
- *
384
- * @type {string}
385
- * @memberof GrantReadResponse
386
- */
387
- 'created_at': string;
388
- /**
389
- *
390
- * @type {boolean}
391
- * @memberof GrantReadResponse
392
- */
393
- 'revoked': boolean;
394
- }
395
- /**
396
- *
397
- * @export
398
- * @enum {string}
399
- */
400
- declare const GrantRelation: {
401
- readonly Owner: "owner";
402
- readonly Editor: "editor";
403
- readonly Viewer: "viewer";
404
- };
405
- type GrantRelation = typeof GrantRelation[keyof typeof GrantRelation];
406
- /**
407
- *
408
- * @export
409
- * @interface HTTPValidationError
410
- */
411
- interface HTTPValidationError {
412
- /**
413
- *
414
- * @type {Array<ValidationError>}
415
- * @memberof HTTPValidationError
416
- */
417
- 'detail'?: Array<ValidationError>;
418
- }
419
- /**
420
- *
421
- * @export
422
- * @interface InputArtifact
423
- */
424
- interface InputArtifact {
425
- /**
426
- *
427
- * @type {string}
428
- * @memberof InputArtifact
429
- */
430
- 'name': string;
431
- /**
432
- *
433
- * @type {string}
434
- * @memberof InputArtifact
435
- */
436
- 'mime_type': string;
437
- /**
438
- *
439
- * @type {{ [key: string]: any; }}
440
- * @memberof InputArtifact
441
- */
442
- 'metadata_schema': {
443
- [key: string]: any;
444
- };
445
- }
446
- /**
447
- * Input artifact containing the slide image and associated metadata.
448
- * @export
449
- * @interface InputArtifactCreationRequest
450
- */
451
- interface InputArtifactCreationRequest {
452
- /**
453
- * Type of artifact. For Atlas H&E-TME, use \"input_slide\"
454
- * @type {string}
455
- * @memberof InputArtifactCreationRequest
456
- */
457
- 'name': string;
458
- /**
459
- * [Signed URL](https://cloud.google.com/cdn/docs/using-signed-urls) to the input artifact file. The URL should be valid for at least 6 days from the payload submission time.
460
- * @type {string}
461
- * @memberof InputArtifactCreationRequest
462
- */
463
- 'download_url': string;
464
- /**
465
- * The metadata of the artifact, required by the application version. The JSON schema of the metadata can be requested by `/v1/versions/{application_version_id}`. The schema is located in `input_artifacts.[].metadata_schema`
466
- * @type {{ [key: string]: any; }}
467
- * @memberof InputArtifactCreationRequest
468
- */
469
- 'metadata': {
470
- [key: string]: any;
471
- };
472
- }
473
- /**
474
- *
475
- * @export
476
- * @interface InputArtifactResultReadResponse
477
- */
478
- interface InputArtifactResultReadResponse {
479
- /**
480
- * The Id of the artifact. Used internally
481
- * @type {string}
482
- * @memberof InputArtifactResultReadResponse
483
- */
484
- 'input_artifact_id': string;
485
- /**
486
- * Name of the input from the schema from the `/v1/versions/{version_id}` endpoint.
487
- * @type {string}
488
- * @memberof InputArtifactResultReadResponse
489
- */
490
- 'name': string;
491
- /**
492
- *
493
- * @type {{ [key: string]: any; }}
494
- * @memberof InputArtifactResultReadResponse
495
- */
496
- 'metadata'?: {
497
- [key: string]: any;
498
- } | null;
499
- /**
500
- *
501
- * @type {string}
502
- * @memberof InputArtifactResultReadResponse
503
- */
504
- 'download_url'?: string | null;
505
- }
506
- /**
507
- * Individual item (slide) to be processed in a run.
508
- * @export
509
- * @interface ItemCreationRequest
510
- */
511
- interface ItemCreationRequest {
512
- /**
513
- * Unique identifier for this item within the run. Used for referencing items. Must be unique across all items in the same run
514
- * @type {string}
515
- * @memberof ItemCreationRequest
516
- */
517
- 'external_id': string;
518
- /**
519
- *
520
- * @type {{ [key: string]: any; }}
521
- * @memberof ItemCreationRequest
522
- */
523
- 'custom_metadata'?: {
524
- [key: string]: any;
525
- } | null;
526
- /**
527
- * List of input artifacts for this item. For Atlas H&E-TME, typically contains one artifact (the slide image)
528
- * @type {Array<InputArtifactCreationRequest>}
529
- * @memberof ItemCreationRequest
530
- */
531
- 'input_artifacts': Array<InputArtifactCreationRequest>;
532
- }
533
- /**
534
- *
535
- * @export
536
- * @enum {string}
537
- */
538
- declare const ItemOutput: {
539
- readonly None: "NONE";
540
- readonly Full: "FULL";
541
- };
542
- type ItemOutput = typeof ItemOutput[keyof typeof ItemOutput];
543
- /**
544
- * Response schema for items in `List Run Items` endpoint
545
- * @export
546
- * @interface ItemResultReadResponse
547
- */
548
- interface ItemResultReadResponse {
549
- /**
550
- * Item UUID generated by the Platform
551
- * @type {string}
552
- * @memberof ItemResultReadResponse
553
- */
554
- 'item_id': string;
555
- /**
556
- * The external_id of the item from the user payload
557
- * @type {string}
558
- * @memberof ItemResultReadResponse
559
- */
560
- 'external_id': string;
561
- /**
562
- *
563
- * @type {{ [key: string]: any; }}
564
- * @memberof ItemResultReadResponse
565
- */
566
- 'custom_metadata': {
567
- [key: string]: any;
568
- } | null;
569
- /**
570
- *
571
- * @type {string}
572
- * @memberof ItemResultReadResponse
573
- */
574
- 'custom_metadata_checksum'?: string | null;
575
- /**
576
- *
577
- * @type {number}
578
- * @memberof ItemResultReadResponse
579
- */
580
- 'queue_position_org'?: number | null;
581
- /**
582
- *
583
- * @type {number}
584
- * @memberof ItemResultReadResponse
585
- */
586
- 'queue_position_platform'?: number | null;
587
- /**
588
- * The item moves from `PENDING` to `PROCESSING` to `TERMINATED` state. When terminated, consult the `termination_reason` property to see whether it was successful.
589
- * @type {ItemState}
590
- * @memberof ItemResultReadResponse
591
- */
592
- 'state': ItemState;
593
- /**
594
- * The output status of the item (NONE, FULL)
595
- * @type {ItemOutput}
596
- * @memberof ItemResultReadResponse
597
- */
598
- 'output': ItemOutput;
599
- /**
600
- *
601
- * @type {ItemTerminationReason}
602
- * @memberof ItemResultReadResponse
603
- */
604
- 'termination_reason'?: ItemTerminationReason | null;
605
- /**
606
- *
607
- * @type {string}
608
- * @memberof ItemResultReadResponse
609
- */
610
- 'error_code'?: string | null;
611
- /**
612
- *
613
- * @type {string}
614
- * @memberof ItemResultReadResponse
615
- */
616
- 'error_message'?: string | null;
617
- /**
618
- *
619
- * @type {string}
620
- * @memberof ItemResultReadResponse
621
- */
622
- 'terminated_at'?: string | null;
623
- /**
624
- * The input artifact(s) provided by the user. For most applications, this will be one artifact that defines the whole slide image to be processed.
625
- * @type {Array<InputArtifactResultReadResponse>}
626
- * @memberof ItemResultReadResponse
627
- */
628
- 'input_artifacts': Array<InputArtifactResultReadResponse>;
629
- /**
630
- * The list of the results generated by the application algorithm. The number of files and their types depend on the particular application version, call `/v1/versions/{version_id}` to get the details.
631
- * @type {Array<OutputArtifactResultReadResponse>}
632
- * @memberof ItemResultReadResponse
633
- */
634
- 'output_artifacts': Array<OutputArtifactResultReadResponse>;
635
- }
636
- /**
637
- *
638
- * @export
639
- * @enum {string}
640
- */
641
- declare const ItemState: {
642
- readonly Pending: "PENDING";
643
- readonly Processing: "PROCESSING";
644
- readonly Terminated: "TERMINATED";
645
- };
646
- type ItemState = typeof ItemState[keyof typeof ItemState];
647
- /**
648
- *
649
- * @export
650
- * @enum {string}
651
- */
652
- declare const ItemTerminationReason: {
653
- readonly Succeeded: "SUCCEEDED";
654
- readonly UserError: "USER_ERROR";
655
- readonly SystemError: "SYSTEM_ERROR";
656
- readonly Skipped: "SKIPPED";
657
- };
658
- type ItemTerminationReason = typeof ItemTerminationReason[keyof typeof ItemTerminationReason];
659
- /**
660
- * Response schema for `Get current user` endpoint
661
- * @export
662
- * @interface MeReadResponse
663
- */
664
- interface MeReadResponse {
665
- /**
666
- *
667
- * @type {UserReadResponse}
668
- * @memberof MeReadResponse
669
- */
670
- 'user': UserReadResponse;
671
- /**
672
- *
673
- * @type {OrganizationReadResponse}
674
- * @memberof MeReadResponse
675
- */
676
- 'organization': OrganizationReadResponse;
677
- }
678
- /**
679
- * Part of response schema for Organization object in `Get current user` endpoint. This model corresponds to the response schema returned from Auth0 GET /v2/organizations/{id} endpoint, flattens out the metadata out and doesn\'t return branding or token_quota objects. For details, see: https://auth0.com/docs/api/management/v2/organizations/get-organizations-by-id #### Configuration for integrating with Aignostics Platform services. The Aignostics Platform API requires signed URLs for input artifacts (slide images). To simplify this process, Aignostics provides a dedicated storage bucket. The HMAC credentials below grant read and write access to this bucket, allowing you to upload files and generate the signed URLs needed for API calls. Additionally, logging and error reporting tokens enable Aignostics to provide better support and monitor system performance for your integration.
680
- * @export
681
- * @interface OrganizationReadResponse
682
- */
683
- interface OrganizationReadResponse {
684
- /**
685
- * Unique organization identifier
686
- * @type {string}
687
- * @memberof OrganizationReadResponse
688
- */
689
- 'id': string;
690
- /**
691
- *
692
- * @type {string}
693
- * @memberof OrganizationReadResponse
694
- */
695
- 'name'?: string | null;
696
- /**
697
- *
698
- * @type {string}
699
- * @memberof OrganizationReadResponse
700
- */
701
- 'display_name'?: string | null;
702
- /**
703
- * HMAC access key ID for the Aignostics-provided storage bucket. Used to authenticate requests for uploading files and generating signed URLs
704
- * @type {string}
705
- * @memberof OrganizationReadResponse
706
- */
707
- 'aignostics_bucket_hmac_access_key_id': string;
708
- /**
709
- * HMAC secret access key paired with the access key ID. Keep this credential secure.
710
- * @type {string}
711
- * @memberof OrganizationReadResponse
712
- */
713
- 'aignostics_bucket_hmac_secret_access_key': string;
714
- /**
715
- * Name of the bucket provided by Aignostics for storing input artifacts (slide images)
716
- * @type {string}
717
- * @memberof OrganizationReadResponse
718
- */
719
- 'aignostics_bucket_name': string;
720
- /**
721
- * Protocol to use for bucket access. Defines the URL scheme for connecting to the storage service
722
- * @type {string}
723
- * @memberof OrganizationReadResponse
724
- */
725
- 'aignostics_bucket_protocol': string;
726
- /**
727
- * Authentication token for Logfire observability service. Enables sending application logs and performance metrics to Aignostics for monitoring and support
728
- * @type {string}
729
- * @memberof OrganizationReadResponse
730
- */
731
- 'aignostics_logfire_token': string;
732
- /**
733
- * Data Source Name (DSN) for Sentry error tracking service. Allows automatic reporting of errors and exceptions to Aignostics support team
734
- * @type {string}
735
- * @memberof OrganizationReadResponse
736
- */
737
- 'aignostics_sentry_dsn': string;
738
- }
739
- /**
740
- *
741
- * @export
742
- * @interface OutputArtifact
743
- */
744
- interface OutputArtifact {
745
- /**
746
- *
747
- * @type {string}
748
- * @memberof OutputArtifact
749
- */
750
- 'name': string;
751
- /**
752
- *
753
- * @type {string}
754
- * @memberof OutputArtifact
755
- */
756
- 'mime_type': string;
757
- /**
758
- *
759
- * @type {{ [key: string]: any; }}
760
- * @memberof OutputArtifact
761
- */
762
- 'metadata_schema': {
763
- [key: string]: any;
764
- };
765
- /**
766
- *
767
- * @type {OutputArtifactScope}
768
- * @memberof OutputArtifact
769
- */
770
- 'scope': OutputArtifactScope;
771
- /**
772
- *
773
- * @type {OutputArtifactVisibility}
774
- * @memberof OutputArtifact
775
- */
776
- 'visibility': OutputArtifactVisibility;
777
- }
778
- /**
779
- *
780
- * @export
781
- * @interface OutputArtifactResultReadResponse
782
- */
783
- interface OutputArtifactResultReadResponse {
784
- /**
785
- * The Id of the artifact. Used internally
786
- * @type {string}
787
- * @memberof OutputArtifactResultReadResponse
788
- */
789
- 'output_artifact_id': string;
790
- /**
791
- * Name of the output from the output schema from the `/v1/versions/{version_id}` endpoint.
792
- * @type {string}
793
- * @memberof OutputArtifactResultReadResponse
794
- */
795
- 'name': string;
796
- /**
797
- *
798
- * @type {{ [key: string]: any; }}
799
- * @memberof OutputArtifactResultReadResponse
800
- */
801
- 'metadata'?: {
802
- [key: string]: any;
803
- } | null;
804
- /**
805
- * The current state of the artifact (PENDING, PROCESSING, TERMINATED)
806
- * @type {ArtifactState}
807
- * @memberof OutputArtifactResultReadResponse
808
- */
809
- 'state': ArtifactState;
810
- /**
811
- *
812
- * @type {ArtifactTerminationReason}
813
- * @memberof OutputArtifactResultReadResponse
814
- */
815
- 'termination_reason'?: ArtifactTerminationReason | null;
816
- /**
817
- * The output status of the artifact (NONE, FULL)
818
- * @type {ArtifactOutput}
819
- * @memberof OutputArtifactResultReadResponse
820
- */
821
- 'output': ArtifactOutput;
822
- /**
823
- *
824
- * @type {string}
825
- * @memberof OutputArtifactResultReadResponse
826
- */
827
- 'error_code'?: string | null;
828
- /**
829
- *
830
- * @type {string}
831
- * @memberof OutputArtifactResultReadResponse
832
- */
833
- 'error_message'?: string | null;
834
- /**
835
- *
836
- * @type {string}
837
- * @memberof OutputArtifactResultReadResponse
838
- */
839
- 'download_url'?: string | null;
840
- }
841
- /**
842
- *
843
- * @export
844
- * @enum {string}
845
- */
846
- declare const OutputArtifactScope: {
847
- readonly Item: "ITEM";
848
- readonly Global: "GLOBAL";
849
- };
850
- type OutputArtifactScope = typeof OutputArtifactScope[keyof typeof OutputArtifactScope];
851
- /**
852
- *
853
- * @export
854
- * @enum {string}
855
- */
856
- declare const OutputArtifactVisibility: {
857
- readonly Internal: "INTERNAL";
858
- readonly External: "EXTERNAL";
859
- };
860
- type OutputArtifactVisibility = typeof OutputArtifactVisibility[keyof typeof OutputArtifactVisibility];
861
- /**
862
- *
863
- * @export
864
- * @enum {string}
865
- */
866
- declare const ResourceType: {
867
- readonly Run: "run";
868
- readonly Item: "item";
869
- readonly OutputArtifact: "output_artifact";
870
- readonly ShareToken: "share_token";
871
- };
872
- type ResourceType = typeof ResourceType[keyof typeof ResourceType];
873
- /**
874
- * Request schema for `Initiate Run` endpoint. It describes which application version is chosen, and which user data should be processed.
875
- * @export
876
- * @interface RunCreationRequest
877
- */
878
- interface RunCreationRequest {
879
- /**
880
- * Unique ID for the application to use for processing
881
- * @type {string}
882
- * @memberof RunCreationRequest
883
- */
884
- 'application_id': string;
885
- /**
886
- *
887
- * @type {string}
888
- * @memberof RunCreationRequest
889
- */
890
- 'version_number'?: string | null;
891
- /**
892
- *
893
- * @type {{ [key: string]: any; }}
894
- * @memberof RunCreationRequest
895
- */
896
- 'custom_metadata'?: {
897
- [key: string]: any;
898
- } | null;
899
- /**
900
- *
901
- * @type {SchedulingRequest}
902
- * @memberof RunCreationRequest
903
- */
904
- 'scheduling'?: SchedulingRequest | null;
905
- /**
906
- *
907
- * @type {{ [key: string]: any; }}
908
- * @memberof RunCreationRequest
909
- */
910
- 'callback_context'?: {
911
- [key: string]: any;
912
- } | null;
913
- /**
914
- * List of items (slides) to process. Each item represents a whole slide image (WSI) with its associated metadata and artifacts
915
- * @type {Array<ItemCreationRequest>}
916
- * @memberof RunCreationRequest
917
- */
918
- 'items': Array<ItemCreationRequest>;
919
- }
920
- /**
921
- *
922
- * @export
923
- * @interface RunCreationResponse
924
- */
925
- interface RunCreationResponse {
926
- /**
927
- *
928
- * @type {string}
929
- * @memberof RunCreationResponse
930
- */
931
- 'run_id': string;
932
- }
933
- /**
934
- *
935
- * @export
936
- * @interface RunItemStatistics
937
- */
938
- interface RunItemStatistics {
939
- /**
940
- * Total number of the items in the run
941
- * @type {number}
942
- * @memberof RunItemStatistics
943
- */
944
- 'item_count': number;
945
- /**
946
- * The number of items in `PENDING` state
947
- * @type {number}
948
- * @memberof RunItemStatistics
949
- */
950
- 'item_pending_count': number;
951
- /**
952
- * The number of items in `PROCESSING` state
953
- * @type {number}
954
- * @memberof RunItemStatistics
955
- */
956
- 'item_processing_count': number;
957
- /**
958
- * The number of items in `TERMINATED` state, and the item termination reason is `USER_ERROR`
959
- * @type {number}
960
- * @memberof RunItemStatistics
961
- */
962
- 'item_user_error_count': number;
963
- /**
964
- * The number of items in `TERMINATED` state, and the item termination reason is `SYSTEM_ERROR`
965
- * @type {number}
966
- * @memberof RunItemStatistics
967
- */
968
- 'item_system_error_count': number;
969
- /**
970
- * The number of items in `TERMINATED` state, and the item termination reason is `SKIPPED`
971
- * @type {number}
972
- * @memberof RunItemStatistics
973
- */
974
- 'item_skipped_count': number;
975
- /**
976
- * The number of items in `TERMINATED` state, and the item termination reason is `SUCCEEDED`
977
- * @type {number}
978
- * @memberof RunItemStatistics
979
- */
980
- 'item_succeeded_count': number;
981
- }
982
- /**
983
- *
984
- * @export
985
- * @enum {string}
986
- */
987
- declare const RunOutput: {
988
- readonly None: "NONE";
989
- readonly Partial: "PARTIAL";
990
- readonly Full: "FULL";
991
- };
992
- type RunOutput = typeof RunOutput[keyof typeof RunOutput];
993
- /**
994
- * Response schema for `Get run details` endpoint
995
- * @export
996
- * @interface RunReadResponse
997
- */
998
- interface RunReadResponse {
999
- /**
1000
- * UUID of the application
1001
- * @type {string}
1002
- * @memberof RunReadResponse
1003
- */
1004
- 'run_id': string;
1005
- /**
1006
- * Application id
1007
- * @type {string}
1008
- * @memberof RunReadResponse
1009
- */
1010
- 'application_id': string;
1011
- /**
1012
- * Application version number
1013
- * @type {string}
1014
- * @memberof RunReadResponse
1015
- */
1016
- 'version_number': string;
1017
- /**
1018
- * When the run request is received by the Platform, the `state` of it is set to `PENDING`. The state changes to `PROCESSING` when at least one item is being processed. After `PROCESSING`, the state of the run can switch back to `PENDING` if there are no processing items, or to `TERMINATED` when the run finished processing.
1019
- * @type {RunState}
1020
- * @memberof RunReadResponse
1021
- */
1022
- 'state': RunState;
1023
- /**
1024
- * The status of the output of the run. When 0 items are successfully processed the output is `NONE`, after one item is successfully processed, the value is set to `PARTIAL`. When all items of the run are successfully processed, the output is set to `FULL`.
1025
- * @type {RunOutput}
1026
- * @memberof RunReadResponse
1027
- */
1028
- 'output': RunOutput;
1029
- /**
1030
- *
1031
- * @type {RunTerminationReason}
1032
- * @memberof RunReadResponse
1033
- */
1034
- 'termination_reason': RunTerminationReason | null;
1035
- /**
1036
- *
1037
- * @type {string}
1038
- * @memberof RunReadResponse
1039
- */
1040
- 'error_code': string | null;
1041
- /**
1042
- *
1043
- * @type {string}
1044
- * @memberof RunReadResponse
1045
- */
1046
- 'error_message': string | null;
1047
- /**
1048
- * Aggregated statistics of the run execution
1049
- * @type {RunItemStatistics}
1050
- * @memberof RunReadResponse
1051
- */
1052
- 'statistics': RunItemStatistics;
1053
- /**
1054
- *
1055
- * @type {{ [key: string]: any; }}
1056
- * @memberof RunReadResponse
1057
- */
1058
- 'custom_metadata'?: {
1059
- [key: string]: any;
1060
- } | null;
1061
- /**
1062
- *
1063
- * @type {string}
1064
- * @memberof RunReadResponse
1065
- */
1066
- 'custom_metadata_checksum'?: string | null;
1067
- /**
1068
- * Timestamp showing when the run was triggered
1069
- * @type {string}
1070
- * @memberof RunReadResponse
1071
- */
1072
- 'submitted_at': string;
1073
- /**
1074
- * Id of the user who triggered the run
1075
- * @type {string}
1076
- * @memberof RunReadResponse
1077
- */
1078
- 'submitted_by': string;
1079
- /**
1080
- *
1081
- * @type {string}
1082
- * @memberof RunReadResponse
1083
- */
1084
- 'organization_id'?: string | null;
1085
- /**
1086
- *
1087
- * @type {string}
1088
- * @memberof RunReadResponse
1089
- */
1090
- 'terminated_at'?: string | null;
1091
- /**
1092
- *
1093
- * @type {number}
1094
- * @memberof RunReadResponse
1095
- */
1096
- 'num_preceding_items_org'?: number | null;
1097
- /**
1098
- *
1099
- * @type {number}
1100
- * @memberof RunReadResponse
1101
- */
1102
- 'num_preceding_items_platform'?: number | null;
1103
- /**
1104
- *
1105
- * @type {SchedulingResponse}
1106
- * @memberof RunReadResponse
1107
- */
1108
- 'scheduling'?: SchedulingResponse | null;
1109
- }
1110
- /**
1111
- *
1112
- * @export
1113
- * @enum {string}
1114
- */
1115
- declare const RunState: {
1116
- readonly Pending: "PENDING";
1117
- readonly Processing: "PROCESSING";
1118
- readonly Terminated: "TERMINATED";
1119
- };
1120
- type RunState = typeof RunState[keyof typeof RunState];
1121
- /**
1122
- *
1123
- * @export
1124
- * @enum {string}
1125
- */
1126
- declare const RunTerminationReason: {
1127
- readonly AllItemsProcessed: "ALL_ITEMS_PROCESSED";
1128
- readonly CanceledBySystem: "CANCELED_BY_SYSTEM";
1129
- readonly CanceledByUser: "CANCELED_BY_USER";
1130
- };
1131
- type RunTerminationReason = typeof RunTerminationReason[keyof typeof RunTerminationReason];
1132
- /**
1133
- * Scheduling constraints for a run.
1134
- * @export
1135
- * @interface SchedulingRequest
1136
- */
1137
- interface SchedulingRequest {
1138
- /**
1139
- *
1140
- * @type {string}
1141
- * @memberof SchedulingRequest
1142
- */
1143
- 'due_date'?: string | null;
1144
- /**
1145
- *
1146
- * @type {string}
1147
- * @memberof SchedulingRequest
1148
- */
1149
- 'deadline'?: string | null;
1150
- }
1151
- /**
1152
- * Scheduling fields returned in run responses.
1153
- * @export
1154
- * @interface SchedulingResponse
1155
- */
1156
- interface SchedulingResponse {
1157
- /**
1158
- *
1159
- * @type {string}
1160
- * @memberof SchedulingResponse
1161
- */
1162
- 'due_date'?: string | null;
1163
- /**
1164
- *
1165
- * @type {string}
1166
- * @memberof SchedulingResponse
1167
- */
1168
- 'deadline'?: string | null;
1169
- }
1170
- /**
1171
- *
1172
- * @export
1173
- * @interface ShareTokenCreateRequest
1174
- */
1175
- interface ShareTokenCreateRequest {
1176
- /**
1177
- *
1178
- * @type {string}
1179
- * @memberof ShareTokenCreateRequest
1180
- */
1181
- 'expires_at'?: string | null;
1182
- }
1183
- /**
1184
- * Returned only on POST — includes the one-time share_token.
1185
- * @export
1186
- * @interface ShareTokenCreateResponse
1187
- */
1188
- interface ShareTokenCreateResponse {
1189
- /**
1190
- *
1191
- * @type {string}
1192
- * @memberof ShareTokenCreateResponse
1193
- */
1194
- 'share_token_id': string;
1195
- /**
1196
- *
1197
- * @type {string}
1198
- * @memberof ShareTokenCreateResponse
1199
- */
1200
- 'share_token': string;
1201
- /**
1202
- *
1203
- * @type {string}
1204
- * @memberof ShareTokenCreateResponse
1205
- */
1206
- 'created_at': string;
1207
- /**
1208
- *
1209
- * @type {string}
1210
- * @memberof ShareTokenCreateResponse
1211
- */
1212
- 'expires_at': string | null;
1213
- /**
1214
- *
1215
- * @type {boolean}
1216
- * @memberof ShareTokenCreateResponse
1217
- */
1218
- 'revoked': boolean;
1219
- }
1220
- /**
1221
- * Returned on GET endpoints — omits share_token.
1222
- * @export
1223
- * @interface ShareTokenReadResponse
1224
- */
1225
- interface ShareTokenReadResponse {
1226
- /**
1227
- *
1228
- * @type {string}
1229
- * @memberof ShareTokenReadResponse
1230
- */
1231
- 'share_token_id': string;
1232
- /**
1233
- *
1234
- * @type {string}
1235
- * @memberof ShareTokenReadResponse
1236
- */
1237
- 'created_at': string;
1238
- /**
1239
- *
1240
- * @type {string}
1241
- * @memberof ShareTokenReadResponse
1242
- */
1243
- 'expires_at': string | null;
1244
- /**
1245
- *
1246
- * @type {boolean}
1247
- * @memberof ShareTokenReadResponse
1248
- */
1249
- 'revoked': boolean;
1250
- }
1251
- /**
1252
- *
1253
- * @export
1254
- * @enum {string}
1255
- */
1256
- declare const SubjectType: {
1257
- readonly User: "user";
1258
- readonly OrganizationAdmin: "organization_admin";
1259
- readonly OrganizationUser: "organization_user";
1260
- readonly ShareToken: "share_token";
1261
- };
1262
- type SubjectType = typeof SubjectType[keyof typeof SubjectType];
1263
- /**
1264
- * Part of response schema for User object in `Get current user` endpoint. This model corresponds to the response schema returned from Auth0 GET /v2/users/{id} endpoint. For details, see: https://auth0.com/docs/api/management/v2/users/get-users-by-id
1265
- * @export
1266
- * @interface UserReadResponse
1267
- */
1268
- interface UserReadResponse {
1269
- /**
1270
- * Unique user identifier
1271
- * @type {string}
1272
- * @memberof UserReadResponse
1273
- */
1274
- 'id': string;
1275
- /**
1276
- *
1277
- * @type {string}
1278
- * @memberof UserReadResponse
1279
- */
1280
- 'email'?: string | null;
1281
- /**
1282
- *
1283
- * @type {boolean}
1284
- * @memberof UserReadResponse
1285
- */
1286
- 'email_verified'?: boolean | null;
1287
- /**
1288
- *
1289
- * @type {string}
1290
- * @memberof UserReadResponse
1291
- */
1292
- 'name'?: string | null;
1293
- /**
1294
- *
1295
- * @type {string}
1296
- * @memberof UserReadResponse
1297
- */
1298
- 'given_name'?: string | null;
1299
- /**
1300
- *
1301
- * @type {string}
1302
- * @memberof UserReadResponse
1303
- */
1304
- 'family_name'?: string | null;
1305
- /**
1306
- *
1307
- * @type {string}
1308
- * @memberof UserReadResponse
1309
- */
1310
- 'nickname'?: string | null;
1311
- /**
1312
- *
1313
- * @type {string}
1314
- * @memberof UserReadResponse
1315
- */
1316
- 'picture'?: string | null;
1317
- /**
1318
- *
1319
- * @type {string}
1320
- * @memberof UserReadResponse
1321
- */
1322
- 'updated_at'?: string | null;
1323
- }
1324
- /**
1325
- *
1326
- * @export
1327
- * @interface ValidationError
1328
- */
1329
- interface ValidationError {
1330
- /**
1331
- *
1332
- * @type {Array<ValidationErrorLocInner>}
1333
- * @memberof ValidationError
1334
- */
1335
- 'loc': Array<ValidationErrorLocInner>;
1336
- /**
1337
- *
1338
- * @type {string}
1339
- * @memberof ValidationError
1340
- */
1341
- 'msg': string;
1342
- /**
1343
- *
1344
- * @type {string}
1345
- * @memberof ValidationError
1346
- */
1347
- 'type': string;
1348
- /**
1349
- *
1350
- * @type {any}
1351
- * @memberof ValidationError
1352
- */
1353
- 'input'?: any;
1354
- /**
1355
- *
1356
- * @type {object}
1357
- * @memberof ValidationError
1358
- */
1359
- 'ctx'?: object;
1360
- }
1361
- /**
1362
- *
1363
- * @export
1364
- * @interface ValidationErrorLocInner
1365
- */
1366
- interface ValidationErrorLocInner {
1367
- }
1368
- /**
1369
- *
1370
- * @export
1371
- * @interface VersionDocumentResponse
1372
- */
1373
- interface VersionDocumentResponse {
1374
- /**
1375
- *
1376
- * @type {string}
1377
- * @memberof VersionDocumentResponse
1378
- */
1379
- 'id': string;
1380
- /**
1381
- *
1382
- * @type {string}
1383
- * @memberof VersionDocumentResponse
1384
- */
1385
- 'name': string;
1386
- /**
1387
- *
1388
- * @type {string}
1389
- * @memberof VersionDocumentResponse
1390
- */
1391
- 'mime_type': string;
1392
- /**
1393
- *
1394
- * @type {VersionDocumentVisibility}
1395
- * @memberof VersionDocumentResponse
1396
- */
1397
- 'visibility': VersionDocumentVisibility;
1398
- /**
1399
- *
1400
- * @type {string}
1401
- * @memberof VersionDocumentResponse
1402
- */
1403
- 'created_at': string;
1404
- /**
1405
- *
1406
- * @type {string}
1407
- * @memberof VersionDocumentResponse
1408
- */
1409
- 'updated_at': string;
1410
- }
1411
- /**
1412
- *
1413
- * @export
1414
- * @enum {string}
1415
- */
1416
- declare const VersionDocumentVisibility: {
1417
- readonly Public: "public";
1418
- readonly Internal: "internal";
1419
- };
1420
- type VersionDocumentVisibility = typeof VersionDocumentVisibility[keyof typeof VersionDocumentVisibility];
1421
- /**
1422
- * Base Response schema for the `Application Version Details` endpoint
1423
- * @export
1424
- * @interface VersionReadResponse
1425
- */
1426
- interface VersionReadResponse {
1427
- /**
1428
- * Semantic version of the application
1429
- * @type {string}
1430
- * @memberof VersionReadResponse
1431
- */
1432
- 'version_number': string;
1433
- /**
1434
- * Description of the changes relative to the previous version
1435
- * @type {string}
1436
- * @memberof VersionReadResponse
1437
- */
1438
- 'changelog': string;
1439
- /**
1440
- * List of the input fields, provided by the User
1441
- * @type {Array<InputArtifact>}
1442
- * @memberof VersionReadResponse
1443
- */
1444
- 'input_artifacts': Array<InputArtifact>;
1445
- /**
1446
- * List of the output fields, generated by the application
1447
- * @type {Array<OutputArtifact>}
1448
- * @memberof VersionReadResponse
1449
- */
1450
- 'output_artifacts': Array<OutputArtifact>;
1451
- /**
1452
- * The timestamp when the application version was registered
1453
- * @type {string}
1454
- * @memberof VersionReadResponse
1455
- */
1456
- 'released_at': string;
1457
- }
1458
- /**
1459
- * PublicApi - axios parameter creator
1460
- * @export
1461
- */
1462
- declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1463
- /**
1464
- * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1465
- * @summary Application Version Details
1466
- * @param {string} applicationId
1467
- * @param {string} version
1468
- * @param {*} [options] Override http request option.
1469
- * @throws {RequiredError}
1470
- */
1471
- applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet: (applicationId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1472
- /**
1473
- * The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
1474
- * @summary Cancel Run
1475
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1476
- * @param {*} [options] Override http request option.
1477
- * @throws {RequiredError}
1478
- */
1479
- cancelRunV1RunsRunIdCancelPost: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1480
- /**
1481
- * Create a grant to share access to a resource with a subject (user or organization).
1482
- * @summary Create Grant
1483
- * @param {GrantCreateRequest} grantCreateRequest
1484
- * @param {*} [options] Override http request option.
1485
- * @throws {RequiredError}
1486
- */
1487
- createGrantV1AccessGrantsPost: (grantCreateRequest: GrantCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1488
- /**
1489
- * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
1490
- * @summary Initiate Run
1491
- * @param {RunCreationRequest} runCreationRequest
1492
- * @param {*} [options] Override http request option.
1493
- * @throws {RequiredError}
1494
- */
1495
- createRunV1RunsPost: (runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1496
- /**
1497
- * Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
1498
- * @summary Create Share Token
1499
- * @param {ShareTokenCreateRequest} shareTokenCreateRequest
1500
- * @param {*} [options] Override http request option.
1501
- * @throws {RequiredError}
1502
- */
1503
- createShareTokenV1AccessShareTokensPost: (shareTokenCreateRequest: ShareTokenCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1504
- /**
1505
- * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
1506
- * @summary Delete Run Items
1507
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1508
- * @param {*} [options] Override http request option.
1509
- * @throws {RequiredError}
1510
- */
1511
- deleteRunItemsV1RunsRunIdArtifactsDelete: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1512
- /**
1513
- * Download the artifact file with the specified artifact_id, belonging to the specified run. The artifact_is is returned by the `GET /v1/runs/{run_id}/items` endpoint as part of the item results, and can also be retrieved via `GET /v1/runs/{run_id}/items/{external_id}`. The endpoint may return a redirect response with a presigned URL to download the artifact file from the storage bucket. The presigned URL is valid for a limited time, so it should be used immediately after receiving the response.
1514
- * @summary Get Artifact Url
1515
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1516
- * @param {string} artifactId The artifact id to download
1517
- * @param {string | null} [shareToken] Share token for accessing shared runs
1518
- * @param {*} [options] Override http request option.
1519
- * @throws {RequiredError}
1520
- */
1521
- getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: (runId: string, artifactId: string, shareToken?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1522
- /**
1523
- * Get a grant by its ID.
1524
- * @summary Get Grant
1525
- * @param {string} grantId Grant ID
1526
- * @param {*} [options] Override http request option.
1527
- * @throws {RequiredError}
1528
- */
1529
- getGrantV1AccessGrantsGrantIdGet: (grantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1530
- /**
1531
- * Retrieve details of a specific item (slide) by its external ID and the run ID.
1532
- * @summary Get Item By Run
1533
- * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
1534
- * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1535
- * @param {string | null} [shareToken] Share token for accessing shared runs
1536
- * @param {*} [options] Override http request option.
1537
- * @throws {RequiredError}
1538
- */
1539
- getItemByRunV1RunsRunIdItemsExternalIdGet: (runId: string, externalId: string, shareToken?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1540
- /**
1541
- * Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
1542
- * @summary Get current user
1543
- * @param {*} [options] Override http request option.
1544
- * @throws {RequiredError}
1545
- */
1546
- getMeV1MeGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1547
- /**
1548
- * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
1549
- * @summary Get run details
1550
- * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1551
- * @param {string | null} [shareToken] Share token for accessing shared runs
1552
- * @param {*} [options] Override http request option.
1553
- * @throws {RequiredError}
1554
- */
1555
- getRunV1RunsRunIdGet: (runId: string, shareToken?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1556
- /**
1557
- * Get a share token by its ID.
1558
- * @summary Get Share Token
1559
- * @param {string} shareTokenId Share token ID
1560
- * @param {*} [options] Override http request option.
1561
- * @throws {RequiredError}
1562
- */
1563
- getShareTokenV1AccessShareTokensShareTokenIdGet: (shareTokenId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1564
- /**
1565
- * Return metadata for a single public document attached to an application version.
1566
- * @summary Get version document metadata
1567
- * @param {string} applicationId
1568
- * @param {string} version
1569
- * @param {string} name
1570
- * @param {*} [options] Override http request option.
1571
- * @throws {RequiredError}
1572
- */
1573
- getVersionDocument: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1574
- /**
1575
- * 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
1576
- * @summary Stream version document content (programmatic)
1577
- * @param {string} applicationId
1578
- * @param {string} version
1579
- * @param {string} name
1580
- * @param {*} [options] Override http request option.
1581
- * @throws {RequiredError}
1582
- */
1583
- getVersionDocumentContent: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1584
- /**
1585
- * 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
1586
- * @summary Download version document (browser)
1587
- * @param {string} applicationId
1588
- * @param {string} version
1589
- * @param {string} name
1590
- * @param {*} [options] Override http request option.
1591
- * @throws {RequiredError}
1592
- */
1593
- getVersionDocumentFile: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1594
- /**
1595
- * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
1596
- * @summary List available applications
1597
- * @param {number} [page]
1598
- * @param {number} [pageSize]
1599
- * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;application_id&#x60; - &#x60;name&#x60; - &#x60;description&#x60; - &#x60;regulatory_classes&#x60; **Examples:** - &#x60;?sort&#x3D;application_id&#x60; - Sort by application_id ascending - &#x60;?sort&#x3D;-name&#x60; - Sort by name descending - &#x60;?sort&#x3D;+description&amp;sort&#x3D;name&#x60; - Sort by description ascending, then name descending
1600
- * @param {*} [options] Override http request option.
1601
- * @throws {RequiredError}
1602
- */
1603
- listApplicationsV1ApplicationsGet: (page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1604
- /**
1605
- * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
1606
- * @summary List Grants
1607
- * @param {ResourceType | null} [resourceType]
1608
- * @param {string | null} [resourceId]
1609
- * @param {SubjectType | null} [subjectType]
1610
- * @param {string | null} [subjectId]
1611
- * @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
1612
- * @param {boolean | null} [revoked]
1613
- * @param {number} [page]
1614
- * @param {number} [pageSize]
1615
- * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
1616
- * @param {*} [options] Override http request option.
1617
- * @throws {RequiredError}
1618
- */
1619
- listGrantsV1AccessGrantsGet: (resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, relation?: Array<GrantRelation> | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1620
- /**
1621
- * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1622
- * @summary List Run Items
1623
- * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1624
- * @param {string | null} [shareToken] Share token for accessing shared runs
1625
- * @param {Array<string> | null} [itemIdIn] Filter for item ids
1626
- * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
1627
- * @param {ItemState | null} [state] Filter items by their state
1628
- * @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
1629
- * @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
1630
- * @param {number} [page]
1631
- * @param {number} [pageSize]
1632
- * @param {Array<string> | null} [sort] Sort the items by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;item_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;item_id&#x60; - Sort by id of the item (ascending) - &#x60;?sort&#x3D;-external_id&#x60; - Sort by external ID (descending) - &#x60;?sort&#x3D;custom_metadata&amp;sort&#x3D;-external_id&#x60; - Sort by metadata, then by external ID (descending)
1633
- * @param {*} [options] Override http request option.
1634
- * @throws {RequiredError}
1635
- */
1636
- listRunItemsV1RunsRunIdItemsGet: (runId: string, shareToken?: string | null, itemIdIn?: Array<string> | null, externalIdIn?: Array<string> | null, state?: ItemState | null, terminationReason?: ItemTerminationReason | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1637
- /**
1638
- * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
1639
- * @summary List Runs
1640
- * @param {string | null} [applicationId] Optional application ID filter
1641
- * @param {string | null} [applicationVersion] Optional Version Name
1642
- * @param {string | null} [externalId] Optionally filter runs by items with this external ID
1643
- * @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: &#x60;$.study&#x60; - Runs that have a study field defined - **Exact value match**: &#x60;$.study ? (@ &#x3D;&#x3D; \&quot;high\&quot;)&#x60; - Runs with specific study value - **Numeric comparison**: &#x60;$.confidence_score ? (@ &gt; 0.75)&#x60; - Runs with confidence score greater than 0.75 - **Array operations**: &#x60;$.tags[*] ? (@ &#x3D;&#x3D; \&quot;draft\&quot;)&#x60; - Runs with tags array containing \&quot;draft\&quot; - **Complex conditions**: &#x60;$.resources ? (@.gpu_count &gt; 2 &amp;&amp; @.memory_gb &gt;&#x3D; 16)&#x60; - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: &#x60;%24.study&#x60; - **Exact value match**: &#x60;%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)&#x60; - **Numeric comparison**: &#x60;%24.confidence_score%20%3F%20(%40%20%3E%200.75)&#x60; - **Array operations**: &#x60;%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)&#x60; - **Complex conditions**: &#x60;%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)&#x60; #### Notes - JSONPath expressions are evaluated using PostgreSQL\&#39;s &#x60;@?&#x60; operator - The &#x60;$.&#x60; prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use &#x60;&amp;&amp;&#x60; for AND operations and &#x60;||&#x60; for OR operations - Regular expressions use &#x60;like_regex&#x60; with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
1644
- * @param {number} [page]
1645
- * @param {number} [pageSize]
1646
- * @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value &#x60;me&#x60; to return only runs submitted by the current user.
1647
- * @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value &#x60;my_org&#x60; to filter by the current user\&#39;s organization.
1648
- * @param {string | null} [forOrganization] Filter runs by organization ID. Available for superadmins (any org) and admins (own org only). When provided, returns all runs for the specified organization instead of only the caller\&#39;s own runs.
1649
- * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;run_id&#x60; - &#x60;application_id&#x60; - &#x60;version_number&#x60; - &#x60;custom_metadata&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;submitted_at&#x60; - Sort by creation time (ascending) - &#x60;?sort&#x3D;-submitted_at&#x60; - Sort by creation time (descending) - &#x60;?sort&#x3D;state&amp;sort&#x3D;-submitted_at&#x60; - Sort by state, then by time (descending)
1650
- * @param {*} [options] Override http request option.
1651
- * @throws {RequiredError}
1652
- */
1653
- listRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, submittedBy?: string | null, organizationId?: string | null, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1654
- /**
1655
- * List share tokens. Service and Superadmin see all tokens; other users see only their own.
1656
- * @summary List Share Tokens
1657
- * @param {string | null} [runId] Filter by run ID
1658
- * @param {string | null} [createdBy] Filter by share token creator
1659
- * @param {boolean | null} [revoked]
1660
- * @param {number} [page]
1661
- * @param {number} [pageSize]
1662
- * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
1663
- * @param {*} [options] Override http request option.
1664
- * @throws {RequiredError}
1665
- */
1666
- listShareTokensV1AccessShareTokensGet: (runId?: string | null, createdBy?: string | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1667
- /**
1668
- * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
1669
- * @summary List version documents
1670
- * @param {string} applicationId
1671
- * @param {string} version
1672
- * @param {*} [options] Override http request option.
1673
- * @throws {RequiredError}
1674
- */
1675
- listVersionDocuments: (applicationId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1676
- /**
1677
- * Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
1678
- * @summary Put Item Custom Metadata By Run
1679
- * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
1680
- * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1681
- * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
1682
- * @param {*} [options] Override http request option.
1683
- * @throws {RequiredError}
1684
- */
1685
- putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut: (runId: string, externalId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1686
- /**
1687
- * Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
1688
- * @summary Put Run Custom Metadata
1689
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1690
- * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
1691
- * @param {*} [options] Override http request option.
1692
- * @throws {RequiredError}
1693
- */
1694
- putRunCustomMetadataV1RunsRunIdCustomMetadataPut: (runId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1695
- /**
1696
- * Retrieve details of a specific application by its ID.
1697
- * @summary Read Application By Id
1698
- * @param {string} applicationId
1699
- * @param {*} [options] Override http request option.
1700
- * @throws {RequiredError}
1701
- */
1702
- readApplicationByIdV1ApplicationsApplicationIdGet: (applicationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1703
- /**
1704
- * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
1705
- * @summary Revoke Grant
1706
- * @param {string} grantId Grant ID
1707
- * @param {*} [options] Override http request option.
1708
- * @throws {RequiredError}
1709
- */
1710
- revokeGrantV1AccessGrantsGrantIdDelete: (grantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1711
- /**
1712
- * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
1713
- * @summary Revoke Share Token
1714
- * @param {string} shareTokenId Share token ID
1715
- * @param {*} [options] Override http request option.
1716
- * @throws {RequiredError}
1717
- */
1718
- revokeShareTokenV1AccessShareTokensShareTokenIdDelete: (shareTokenId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1719
- };
1720
- /**
1721
- * PublicApi - functional programming interface
1722
- * @export
1723
- */
1724
- declare const PublicApiFp: (configuration?: Configuration) => {
1725
- /**
1726
- * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1727
- * @summary Application Version Details
1728
- * @param {string} applicationId
1729
- * @param {string} version
1730
- * @param {*} [options] Override http request option.
1731
- * @throws {RequiredError}
1732
- */
1733
- applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(applicationId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VersionReadResponse>>;
1734
- /**
1735
- * The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
1736
- * @summary Cancel Run
1737
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1738
- * @param {*} [options] Override http request option.
1739
- * @throws {RequiredError}
1740
- */
1741
- cancelRunV1RunsRunIdCancelPost(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1742
- /**
1743
- * Create a grant to share access to a resource with a subject (user or organization).
1744
- * @summary Create Grant
1745
- * @param {GrantCreateRequest} grantCreateRequest
1746
- * @param {*} [options] Override http request option.
1747
- * @throws {RequiredError}
1748
- */
1749
- createGrantV1AccessGrantsPost(grantCreateRequest: GrantCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GrantReadResponse>>;
1750
- /**
1751
- * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
1752
- * @summary Initiate Run
1753
- * @param {RunCreationRequest} runCreationRequest
1754
- * @param {*} [options] Override http request option.
1755
- * @throws {RequiredError}
1756
- */
1757
- createRunV1RunsPost(runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunCreationResponse>>;
1758
- /**
1759
- * Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
1760
- * @summary Create Share Token
1761
- * @param {ShareTokenCreateRequest} shareTokenCreateRequest
1762
- * @param {*} [options] Override http request option.
1763
- * @throws {RequiredError}
1764
- */
1765
- createShareTokenV1AccessShareTokensPost(shareTokenCreateRequest: ShareTokenCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareTokenCreateResponse>>;
1766
- /**
1767
- * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
1768
- * @summary Delete Run Items
1769
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1770
- * @param {*} [options] Override http request option.
1771
- * @throws {RequiredError}
1772
- */
1773
- deleteRunItemsV1RunsRunIdArtifactsDelete(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1774
- /**
1775
- * Download the artifact file with the specified artifact_id, belonging to the specified run. The artifact_is is returned by the `GET /v1/runs/{run_id}/items` endpoint as part of the item results, and can also be retrieved via `GET /v1/runs/{run_id}/items/{external_id}`. The endpoint may return a redirect response with a presigned URL to download the artifact file from the storage bucket. The presigned URL is valid for a limited time, so it should be used immediately after receiving the response.
1776
- * @summary Get Artifact Url
1777
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1778
- * @param {string} artifactId The artifact id to download
1779
- * @param {string | null} [shareToken] Share token for accessing shared runs
1780
- * @param {*} [options] Override http request option.
1781
- * @throws {RequiredError}
1782
- */
1783
- getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId: string, artifactId: string, shareToken?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1784
- /**
1785
- * Get a grant by its ID.
1786
- * @summary Get Grant
1787
- * @param {string} grantId Grant ID
1788
- * @param {*} [options] Override http request option.
1789
- * @throws {RequiredError}
1790
- */
1791
- getGrantV1AccessGrantsGrantIdGet(grantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GrantReadResponse>>;
1792
- /**
1793
- * Retrieve details of a specific item (slide) by its external ID and the run ID.
1794
- * @summary Get Item By Run
1795
- * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
1796
- * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1797
- * @param {string | null} [shareToken] Share token for accessing shared runs
1798
- * @param {*} [options] Override http request option.
1799
- * @throws {RequiredError}
1800
- */
1801
- getItemByRunV1RunsRunIdItemsExternalIdGet(runId: string, externalId: string, shareToken?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemResultReadResponse>>;
1802
- /**
1803
- * Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
1804
- * @summary Get current user
1805
- * @param {*} [options] Override http request option.
1806
- * @throws {RequiredError}
1807
- */
1808
- getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeReadResponse>>;
1809
- /**
1810
- * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
1811
- * @summary Get run details
1812
- * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1813
- * @param {string | null} [shareToken] Share token for accessing shared runs
1814
- * @param {*} [options] Override http request option.
1815
- * @throws {RequiredError}
1816
- */
1817
- getRunV1RunsRunIdGet(runId: string, shareToken?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunReadResponse>>;
1818
- /**
1819
- * Get a share token by its ID.
1820
- * @summary Get Share Token
1821
- * @param {string} shareTokenId Share token ID
1822
- * @param {*} [options] Override http request option.
1823
- * @throws {RequiredError}
1824
- */
1825
- getShareTokenV1AccessShareTokensShareTokenIdGet(shareTokenId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareTokenReadResponse>>;
1826
- /**
1827
- * Return metadata for a single public document attached to an application version.
1828
- * @summary Get version document metadata
1829
- * @param {string} applicationId
1830
- * @param {string} version
1831
- * @param {string} name
1832
- * @param {*} [options] Override http request option.
1833
- * @throws {RequiredError}
1834
- */
1835
- getVersionDocument(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VersionDocumentResponse>>;
1836
- /**
1837
- * 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
1838
- * @summary Stream version document content (programmatic)
1839
- * @param {string} applicationId
1840
- * @param {string} version
1841
- * @param {string} name
1842
- * @param {*} [options] Override http request option.
1843
- * @throws {RequiredError}
1844
- */
1845
- getVersionDocumentContent(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1846
- /**
1847
- * 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
1848
- * @summary Download version document (browser)
1849
- * @param {string} applicationId
1850
- * @param {string} version
1851
- * @param {string} name
1852
- * @param {*} [options] Override http request option.
1853
- * @throws {RequiredError}
1854
- */
1855
- getVersionDocumentFile(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1856
- /**
1857
- * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
1858
- * @summary List available applications
1859
- * @param {number} [page]
1860
- * @param {number} [pageSize]
1861
- * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;application_id&#x60; - &#x60;name&#x60; - &#x60;description&#x60; - &#x60;regulatory_classes&#x60; **Examples:** - &#x60;?sort&#x3D;application_id&#x60; - Sort by application_id ascending - &#x60;?sort&#x3D;-name&#x60; - Sort by name descending - &#x60;?sort&#x3D;+description&amp;sort&#x3D;name&#x60; - Sort by description ascending, then name descending
1862
- * @param {*} [options] Override http request option.
1863
- * @throws {RequiredError}
1864
- */
1865
- listApplicationsV1ApplicationsGet(page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicationReadShortResponse>>>;
1866
- /**
1867
- * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
1868
- * @summary List Grants
1869
- * @param {ResourceType | null} [resourceType]
1870
- * @param {string | null} [resourceId]
1871
- * @param {SubjectType | null} [subjectType]
1872
- * @param {string | null} [subjectId]
1873
- * @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
1874
- * @param {boolean | null} [revoked]
1875
- * @param {number} [page]
1876
- * @param {number} [pageSize]
1877
- * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
1878
- * @param {*} [options] Override http request option.
1879
- * @throws {RequiredError}
1880
- */
1881
- listGrantsV1AccessGrantsGet(resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, relation?: Array<GrantRelation> | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GrantReadResponse>>>;
1882
- /**
1883
- * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
1884
- * @summary List Run Items
1885
- * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1886
- * @param {string | null} [shareToken] Share token for accessing shared runs
1887
- * @param {Array<string> | null} [itemIdIn] Filter for item ids
1888
- * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
1889
- * @param {ItemState | null} [state] Filter items by their state
1890
- * @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
1891
- * @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
1892
- * @param {number} [page]
1893
- * @param {number} [pageSize]
1894
- * @param {Array<string> | null} [sort] Sort the items by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;item_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;item_id&#x60; - Sort by id of the item (ascending) - &#x60;?sort&#x3D;-external_id&#x60; - Sort by external ID (descending) - &#x60;?sort&#x3D;custom_metadata&amp;sort&#x3D;-external_id&#x60; - Sort by metadata, then by external ID (descending)
1895
- * @param {*} [options] Override http request option.
1896
- * @throws {RequiredError}
1897
- */
1898
- listRunItemsV1RunsRunIdItemsGet(runId: string, shareToken?: string | null, itemIdIn?: Array<string> | null, externalIdIn?: Array<string> | null, state?: ItemState | null, terminationReason?: ItemTerminationReason | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ItemResultReadResponse>>>;
1899
- /**
1900
- * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
1901
- * @summary List Runs
1902
- * @param {string | null} [applicationId] Optional application ID filter
1903
- * @param {string | null} [applicationVersion] Optional Version Name
1904
- * @param {string | null} [externalId] Optionally filter runs by items with this external ID
1905
- * @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: &#x60;$.study&#x60; - Runs that have a study field defined - **Exact value match**: &#x60;$.study ? (@ &#x3D;&#x3D; \&quot;high\&quot;)&#x60; - Runs with specific study value - **Numeric comparison**: &#x60;$.confidence_score ? (@ &gt; 0.75)&#x60; - Runs with confidence score greater than 0.75 - **Array operations**: &#x60;$.tags[*] ? (@ &#x3D;&#x3D; \&quot;draft\&quot;)&#x60; - Runs with tags array containing \&quot;draft\&quot; - **Complex conditions**: &#x60;$.resources ? (@.gpu_count &gt; 2 &amp;&amp; @.memory_gb &gt;&#x3D; 16)&#x60; - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: &#x60;%24.study&#x60; - **Exact value match**: &#x60;%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)&#x60; - **Numeric comparison**: &#x60;%24.confidence_score%20%3F%20(%40%20%3E%200.75)&#x60; - **Array operations**: &#x60;%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)&#x60; - **Complex conditions**: &#x60;%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)&#x60; #### Notes - JSONPath expressions are evaluated using PostgreSQL\&#39;s &#x60;@?&#x60; operator - The &#x60;$.&#x60; prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use &#x60;&amp;&amp;&#x60; for AND operations and &#x60;||&#x60; for OR operations - Regular expressions use &#x60;like_regex&#x60; with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
1906
- * @param {number} [page]
1907
- * @param {number} [pageSize]
1908
- * @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value &#x60;me&#x60; to return only runs submitted by the current user.
1909
- * @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value &#x60;my_org&#x60; to filter by the current user\&#39;s organization.
1910
- * @param {string | null} [forOrganization] Filter runs by organization ID. Available for superadmins (any org) and admins (own org only). When provided, returns all runs for the specified organization instead of only the caller\&#39;s own runs.
1911
- * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;run_id&#x60; - &#x60;application_id&#x60; - &#x60;version_number&#x60; - &#x60;custom_metadata&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;submitted_at&#x60; - Sort by creation time (ascending) - &#x60;?sort&#x3D;-submitted_at&#x60; - Sort by creation time (descending) - &#x60;?sort&#x3D;state&amp;sort&#x3D;-submitted_at&#x60; - Sort by state, then by time (descending)
1912
- * @param {*} [options] Override http request option.
1913
- * @throws {RequiredError}
1914
- */
1915
- listRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, submittedBy?: string | null, organizationId?: string | null, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
1916
- /**
1917
- * List share tokens. Service and Superadmin see all tokens; other users see only their own.
1918
- * @summary List Share Tokens
1919
- * @param {string | null} [runId] Filter by run ID
1920
- * @param {string | null} [createdBy] Filter by share token creator
1921
- * @param {boolean | null} [revoked]
1922
- * @param {number} [page]
1923
- * @param {number} [pageSize]
1924
- * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
1925
- * @param {*} [options] Override http request option.
1926
- * @throws {RequiredError}
1927
- */
1928
- listShareTokensV1AccessShareTokensGet(runId?: string | null, createdBy?: string | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ShareTokenReadResponse>>>;
1929
- /**
1930
- * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
1931
- * @summary List version documents
1932
- * @param {string} applicationId
1933
- * @param {string} version
1934
- * @param {*} [options] Override http request option.
1935
- * @throws {RequiredError}
1936
- */
1937
- listVersionDocuments(applicationId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VersionDocumentResponse>>>;
1938
- /**
1939
- * Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
1940
- * @summary Put Item Custom Metadata By Run
1941
- * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
1942
- * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1943
- * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
1944
- * @param {*} [options] Override http request option.
1945
- * @throws {RequiredError}
1946
- */
1947
- putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(runId: string, externalId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomMetadataUpdateResponse>>;
1948
- /**
1949
- * Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
1950
- * @summary Put Run Custom Metadata
1951
- * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1952
- * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
1953
- * @param {*} [options] Override http request option.
1954
- * @throws {RequiredError}
1955
- */
1956
- putRunCustomMetadataV1RunsRunIdCustomMetadataPut(runId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomMetadataUpdateResponse>>;
1957
- /**
1958
- * Retrieve details of a specific application by its ID.
1959
- * @summary Read Application By Id
1960
- * @param {string} applicationId
1961
- * @param {*} [options] Override http request option.
1962
- * @throws {RequiredError}
1963
- */
1964
- readApplicationByIdV1ApplicationsApplicationIdGet(applicationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationReadResponse>>;
1965
- /**
1966
- * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
1967
- * @summary Revoke Grant
1968
- * @param {string} grantId Grant ID
1969
- * @param {*} [options] Override http request option.
1970
- * @throws {RequiredError}
1971
- */
1972
- revokeGrantV1AccessGrantsGrantIdDelete(grantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GrantReadResponse>>;
1973
- /**
1974
- * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
1975
- * @summary Revoke Share Token
1976
- * @param {string} shareTokenId Share token ID
1977
- * @param {*} [options] Override http request option.
1978
- * @throws {RequiredError}
1979
- */
1980
- revokeShareTokenV1AccessShareTokensShareTokenIdDelete(shareTokenId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareTokenReadResponse>>;
1981
- };
1982
- /**
1983
- * PublicApi - factory interface
1984
- * @export
1985
- */
1986
- declare const PublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1987
- /**
1988
- * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1989
- * @summary Application Version Details
1990
- * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
1991
- * @param {*} [options] Override http request option.
1992
- * @throws {RequiredError}
1993
- */
1994
- applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionReadResponse>;
1995
- /**
1996
- * The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
1997
- * @summary Cancel Run
1998
- * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
1999
- * @param {*} [options] Override http request option.
2000
- * @throws {RequiredError}
2001
- */
2002
- cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
2003
- /**
2004
- * Create a grant to share access to a resource with a subject (user or organization).
2005
- * @summary Create Grant
2006
- * @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
2007
- * @param {*} [options] Override http request option.
2008
- * @throws {RequiredError}
2009
- */
2010
- createGrantV1AccessGrantsPost(requestParameters: PublicApiCreateGrantV1AccessGrantsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
2011
- /**
2012
- * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
2013
- * @summary Initiate Run
2014
- * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
2015
- * @param {*} [options] Override http request option.
2016
- * @throws {RequiredError}
2017
- */
2018
- createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
2019
- /**
2020
- * Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
2021
- * @summary Create Share Token
2022
- * @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
2023
- * @param {*} [options] Override http request option.
2024
- * @throws {RequiredError}
2025
- */
2026
- createShareTokenV1AccessShareTokensPost(requestParameters: PublicApiCreateShareTokenV1AccessShareTokensPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenCreateResponse>;
2027
- /**
2028
- * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
2029
- * @summary Delete Run Items
2030
- * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
2031
- * @param {*} [options] Override http request option.
2032
- * @throws {RequiredError}
2033
- */
2034
- deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
2035
- /**
2036
- * Download the artifact file with the specified artifact_id, belonging to the specified run. The artifact_is is returned by the `GET /v1/runs/{run_id}/items` endpoint as part of the item results, and can also be retrieved via `GET /v1/runs/{run_id}/items/{external_id}`. The endpoint may return a redirect response with a presigned URL to download the artifact file from the storage bucket. The presigned URL is valid for a limited time, so it should be used immediately after receiving the response.
2037
- * @summary Get Artifact Url
2038
- * @param {PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest} requestParameters Request parameters.
2039
- * @param {*} [options] Override http request option.
2040
- * @throws {RequiredError}
2041
- */
2042
- getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
2043
- /**
2044
- * Get a grant by its ID.
2045
- * @summary Get Grant
2046
- * @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
2047
- * @param {*} [options] Override http request option.
2048
- * @throws {RequiredError}
2049
- */
2050
- getGrantV1AccessGrantsGrantIdGet(requestParameters: PublicApiGetGrantV1AccessGrantsGrantIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
2051
- /**
2052
- * Retrieve details of a specific item (slide) by its external ID and the run ID.
2053
- * @summary Get Item By Run
2054
- * @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
2055
- * @param {*} [options] Override http request option.
2056
- * @throws {RequiredError}
2057
- */
2058
- getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters: PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemResultReadResponse>;
2059
- /**
2060
- * Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
2061
- * @summary Get current user
2062
- * @param {*} [options] Override http request option.
2063
- * @throws {RequiredError}
2064
- */
2065
- getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
2066
- /**
2067
- * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
2068
- * @summary Get run details
2069
- * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
2070
- * @param {*} [options] Override http request option.
2071
- * @throws {RequiredError}
2072
- */
2073
- getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
2074
- /**
2075
- * Get a share token by its ID.
2076
- * @summary Get Share Token
2077
- * @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
2078
- * @param {*} [options] Override http request option.
2079
- * @throws {RequiredError}
2080
- */
2081
- getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters: PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
2082
- /**
2083
- * Return metadata for a single public document attached to an application version.
2084
- * @summary Get version document metadata
2085
- * @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
2086
- * @param {*} [options] Override http request option.
2087
- * @throws {RequiredError}
2088
- */
2089
- getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionDocumentResponse>;
2090
- /**
2091
- * 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
2092
- * @summary Stream version document content (programmatic)
2093
- * @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
2094
- * @param {*} [options] Override http request option.
2095
- * @throws {RequiredError}
2096
- */
2097
- getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2098
- /**
2099
- * 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
2100
- * @summary Download version document (browser)
2101
- * @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
2102
- * @param {*} [options] Override http request option.
2103
- * @throws {RequiredError}
2104
- */
2105
- getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2106
- /**
2107
- * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
2108
- * @summary List available applications
2109
- * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
2110
- * @param {*} [options] Override http request option.
2111
- * @throws {RequiredError}
2112
- */
2113
- listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
2114
- /**
2115
- * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
2116
- * @summary List Grants
2117
- * @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
2118
- * @param {*} [options] Override http request option.
2119
- * @throws {RequiredError}
2120
- */
2121
- listGrantsV1AccessGrantsGet(requestParameters?: PublicApiListGrantsV1AccessGrantsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<GrantReadResponse>>;
2122
- /**
2123
- * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
2124
- * @summary List Run Items
2125
- * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
2126
- * @param {*} [options] Override http request option.
2127
- * @throws {RequiredError}
2128
- */
2129
- listRunItemsV1RunsRunIdItemsGet(requestParameters: PublicApiListRunItemsV1RunsRunIdItemsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ItemResultReadResponse>>;
2130
- /**
2131
- * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
2132
- * @summary List Runs
2133
- * @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
2134
- * @param {*} [options] Override http request option.
2135
- * @throws {RequiredError}
2136
- */
2137
- listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
2138
- /**
2139
- * List share tokens. Service and Superadmin see all tokens; other users see only their own.
2140
- * @summary List Share Tokens
2141
- * @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
2142
- * @param {*} [options] Override http request option.
2143
- * @throws {RequiredError}
2144
- */
2145
- listShareTokensV1AccessShareTokensGet(requestParameters?: PublicApiListShareTokensV1AccessShareTokensGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ShareTokenReadResponse>>;
2146
- /**
2147
- * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
2148
- * @summary List version documents
2149
- * @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
2150
- * @param {*} [options] Override http request option.
2151
- * @throws {RequiredError}
2152
- */
2153
- listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<VersionDocumentResponse>>;
2154
- /**
2155
- * Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
2156
- * @summary Put Item Custom Metadata By Run
2157
- * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
2158
- * @param {*} [options] Override http request option.
2159
- * @throws {RequiredError}
2160
- */
2161
- putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
2162
- /**
2163
- * Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
2164
- * @summary Put Run Custom Metadata
2165
- * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
2166
- * @param {*} [options] Override http request option.
2167
- * @throws {RequiredError}
2168
- */
2169
- putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
2170
- /**
2171
- * Retrieve details of a specific application by its ID.
2172
- * @summary Read Application By Id
2173
- * @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
2174
- * @param {*} [options] Override http request option.
2175
- * @throws {RequiredError}
2176
- */
2177
- readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationReadResponse>;
2178
- /**
2179
- * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
2180
- * @summary Revoke Grant
2181
- * @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
2182
- * @param {*} [options] Override http request option.
2183
- * @throws {RequiredError}
2184
- */
2185
- revokeGrantV1AccessGrantsGrantIdDelete(requestParameters: PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
2186
- /**
2187
- * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
2188
- * @summary Revoke Share Token
2189
- * @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
2190
- * @param {*} [options] Override http request option.
2191
- * @throws {RequiredError}
2192
- */
2193
- revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters: PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
2194
- };
2195
- /**
2196
- * PublicApi - interface
2197
- * @export
2198
- * @interface PublicApi
2199
- */
2200
- interface PublicApiInterface {
2201
- /**
2202
- * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
2203
- * @summary Application Version Details
2204
- * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
2205
- * @param {*} [options] Override http request option.
2206
- * @throws {RequiredError}
2207
- * @memberof PublicApiInterface
2208
- */
2209
- applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionReadResponse>;
2210
- /**
2211
- * The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
2212
- * @summary Cancel Run
2213
- * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
2214
- * @param {*} [options] Override http request option.
2215
- * @throws {RequiredError}
2216
- * @memberof PublicApiInterface
2217
- */
2218
- cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
2219
- /**
2220
- * Create a grant to share access to a resource with a subject (user or organization).
2221
- * @summary Create Grant
2222
- * @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
2223
- * @param {*} [options] Override http request option.
2224
- * @throws {RequiredError}
2225
- * @memberof PublicApiInterface
2226
- */
2227
- createGrantV1AccessGrantsPost(requestParameters: PublicApiCreateGrantV1AccessGrantsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
2228
- /**
2229
- * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
2230
- * @summary Initiate Run
2231
- * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
2232
- * @param {*} [options] Override http request option.
2233
- * @throws {RequiredError}
2234
- * @memberof PublicApiInterface
2235
- */
2236
- createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
2237
- /**
2238
- * Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
2239
- * @summary Create Share Token
2240
- * @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
2241
- * @param {*} [options] Override http request option.
2242
- * @throws {RequiredError}
2243
- * @memberof PublicApiInterface
2244
- */
2245
- createShareTokenV1AccessShareTokensPost(requestParameters: PublicApiCreateShareTokenV1AccessShareTokensPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenCreateResponse>;
2246
- /**
2247
- * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
2248
- * @summary Delete Run Items
2249
- * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
2250
- * @param {*} [options] Override http request option.
2251
- * @throws {RequiredError}
2252
- * @memberof PublicApiInterface
2253
- */
2254
- deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
2255
- /**
2256
- * Download the artifact file with the specified artifact_id, belonging to the specified run. The artifact_is is returned by the `GET /v1/runs/{run_id}/items` endpoint as part of the item results, and can also be retrieved via `GET /v1/runs/{run_id}/items/{external_id}`. The endpoint may return a redirect response with a presigned URL to download the artifact file from the storage bucket. The presigned URL is valid for a limited time, so it should be used immediately after receiving the response.
2257
- * @summary Get Artifact Url
2258
- * @param {PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest} requestParameters Request parameters.
2259
- * @param {*} [options] Override http request option.
2260
- * @throws {RequiredError}
2261
- * @memberof PublicApiInterface
2262
- */
2263
- getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
2264
- /**
2265
- * Get a grant by its ID.
2266
- * @summary Get Grant
2267
- * @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
2268
- * @param {*} [options] Override http request option.
2269
- * @throws {RequiredError}
2270
- * @memberof PublicApiInterface
2271
- */
2272
- getGrantV1AccessGrantsGrantIdGet(requestParameters: PublicApiGetGrantV1AccessGrantsGrantIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
2273
- /**
2274
- * Retrieve details of a specific item (slide) by its external ID and the run ID.
2275
- * @summary Get Item By Run
2276
- * @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
2277
- * @param {*} [options] Override http request option.
2278
- * @throws {RequiredError}
2279
- * @memberof PublicApiInterface
2280
- */
2281
- getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters: PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemResultReadResponse>;
2282
- /**
2283
- * Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
2284
- * @summary Get current user
2285
- * @param {*} [options] Override http request option.
2286
- * @throws {RequiredError}
2287
- * @memberof PublicApiInterface
2288
- */
2289
- getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
2290
- /**
2291
- * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
2292
- * @summary Get run details
2293
- * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
2294
- * @param {*} [options] Override http request option.
2295
- * @throws {RequiredError}
2296
- * @memberof PublicApiInterface
2297
- */
2298
- getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
2299
- /**
2300
- * Get a share token by its ID.
2301
- * @summary Get Share Token
2302
- * @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
2303
- * @param {*} [options] Override http request option.
2304
- * @throws {RequiredError}
2305
- * @memberof PublicApiInterface
2306
- */
2307
- getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters: PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
2308
- /**
2309
- * Return metadata for a single public document attached to an application version.
2310
- * @summary Get version document metadata
2311
- * @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
2312
- * @param {*} [options] Override http request option.
2313
- * @throws {RequiredError}
2314
- * @memberof PublicApiInterface
2315
- */
2316
- getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionDocumentResponse>;
2317
- /**
2318
- * 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
2319
- * @summary Stream version document content (programmatic)
2320
- * @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
2321
- * @param {*} [options] Override http request option.
2322
- * @throws {RequiredError}
2323
- * @memberof PublicApiInterface
2324
- */
2325
- getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2326
- /**
2327
- * 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
2328
- * @summary Download version document (browser)
2329
- * @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
2330
- * @param {*} [options] Override http request option.
2331
- * @throws {RequiredError}
2332
- * @memberof PublicApiInterface
2333
- */
2334
- getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2335
- /**
2336
- * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
2337
- * @summary List available applications
2338
- * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
2339
- * @param {*} [options] Override http request option.
2340
- * @throws {RequiredError}
2341
- * @memberof PublicApiInterface
2342
- */
2343
- listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
2344
- /**
2345
- * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
2346
- * @summary List Grants
2347
- * @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
2348
- * @param {*} [options] Override http request option.
2349
- * @throws {RequiredError}
2350
- * @memberof PublicApiInterface
2351
- */
2352
- listGrantsV1AccessGrantsGet(requestParameters?: PublicApiListGrantsV1AccessGrantsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<GrantReadResponse>>;
2353
- /**
2354
- * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
2355
- * @summary List Run Items
2356
- * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
2357
- * @param {*} [options] Override http request option.
2358
- * @throws {RequiredError}
2359
- * @memberof PublicApiInterface
2360
- */
2361
- listRunItemsV1RunsRunIdItemsGet(requestParameters: PublicApiListRunItemsV1RunsRunIdItemsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ItemResultReadResponse>>;
2362
- /**
2363
- * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
2364
- * @summary List Runs
2365
- * @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
2366
- * @param {*} [options] Override http request option.
2367
- * @throws {RequiredError}
2368
- * @memberof PublicApiInterface
2369
- */
2370
- listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
2371
- /**
2372
- * List share tokens. Service and Superadmin see all tokens; other users see only their own.
2373
- * @summary List Share Tokens
2374
- * @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
2375
- * @param {*} [options] Override http request option.
2376
- * @throws {RequiredError}
2377
- * @memberof PublicApiInterface
2378
- */
2379
- listShareTokensV1AccessShareTokensGet(requestParameters?: PublicApiListShareTokensV1AccessShareTokensGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ShareTokenReadResponse>>;
2380
- /**
2381
- * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
2382
- * @summary List version documents
2383
- * @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
2384
- * @param {*} [options] Override http request option.
2385
- * @throws {RequiredError}
2386
- * @memberof PublicApiInterface
2387
- */
2388
- listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<VersionDocumentResponse>>;
2389
- /**
2390
- * Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
2391
- * @summary Put Item Custom Metadata By Run
2392
- * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
2393
- * @param {*} [options] Override http request option.
2394
- * @throws {RequiredError}
2395
- * @memberof PublicApiInterface
2396
- */
2397
- putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
2398
- /**
2399
- * Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
2400
- * @summary Put Run Custom Metadata
2401
- * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
2402
- * @param {*} [options] Override http request option.
2403
- * @throws {RequiredError}
2404
- * @memberof PublicApiInterface
2405
- */
2406
- putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
2407
- /**
2408
- * Retrieve details of a specific application by its ID.
2409
- * @summary Read Application By Id
2410
- * @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
2411
- * @param {*} [options] Override http request option.
2412
- * @throws {RequiredError}
2413
- * @memberof PublicApiInterface
2414
- */
2415
- readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationReadResponse>;
2416
- /**
2417
- * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
2418
- * @summary Revoke Grant
2419
- * @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
2420
- * @param {*} [options] Override http request option.
2421
- * @throws {RequiredError}
2422
- * @memberof PublicApiInterface
2423
- */
2424
- revokeGrantV1AccessGrantsGrantIdDelete(requestParameters: PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
2425
- /**
2426
- * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
2427
- * @summary Revoke Share Token
2428
- * @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
2429
- * @param {*} [options] Override http request option.
2430
- * @throws {RequiredError}
2431
- * @memberof PublicApiInterface
2432
- */
2433
- revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters: PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
2434
- }
2435
- /**
2436
- * Request parameters for applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet operation in PublicApi.
2437
- * @export
2438
- * @interface PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest
2439
- */
2440
- interface PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest {
2441
- /**
2442
- *
2443
- * @type {string}
2444
- * @memberof PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet
2445
- */
2446
- readonly applicationId: string;
2447
- /**
2448
- *
2449
- * @type {string}
2450
- * @memberof PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet
2451
- */
2452
- readonly version: string;
2453
- }
2454
- /**
2455
- * Request parameters for cancelRunV1RunsRunIdCancelPost operation in PublicApi.
2456
- * @export
2457
- * @interface PublicApiCancelRunV1RunsRunIdCancelPostRequest
2458
- */
2459
- interface PublicApiCancelRunV1RunsRunIdCancelPostRequest {
2460
- /**
2461
- * Run id, returned by &#x60;POST /runs/&#x60; endpoint
2462
- * @type {string}
2463
- * @memberof PublicApiCancelRunV1RunsRunIdCancelPost
2464
- */
2465
- readonly runId: string;
2466
- }
2467
- /**
2468
- * Request parameters for createGrantV1AccessGrantsPost operation in PublicApi.
2469
- * @export
2470
- * @interface PublicApiCreateGrantV1AccessGrantsPostRequest
2471
- */
2472
- interface PublicApiCreateGrantV1AccessGrantsPostRequest {
2473
- /**
2474
- *
2475
- * @type {GrantCreateRequest}
2476
- * @memberof PublicApiCreateGrantV1AccessGrantsPost
2477
- */
2478
- readonly grantCreateRequest: GrantCreateRequest;
2479
- }
2480
- /**
2481
- * Request parameters for createRunV1RunsPost operation in PublicApi.
2482
- * @export
2483
- * @interface PublicApiCreateRunV1RunsPostRequest
2484
- */
2485
- interface PublicApiCreateRunV1RunsPostRequest {
2486
- /**
2487
- *
2488
- * @type {RunCreationRequest}
2489
- * @memberof PublicApiCreateRunV1RunsPost
2490
- */
2491
- readonly runCreationRequest: RunCreationRequest;
2492
- }
2493
- /**
2494
- * Request parameters for createShareTokenV1AccessShareTokensPost operation in PublicApi.
2495
- * @export
2496
- * @interface PublicApiCreateShareTokenV1AccessShareTokensPostRequest
2497
- */
2498
- interface PublicApiCreateShareTokenV1AccessShareTokensPostRequest {
2499
- /**
2500
- *
2501
- * @type {ShareTokenCreateRequest}
2502
- * @memberof PublicApiCreateShareTokenV1AccessShareTokensPost
2503
- */
2504
- readonly shareTokenCreateRequest: ShareTokenCreateRequest;
2505
- }
2506
- /**
2507
- * Request parameters for deleteRunItemsV1RunsRunIdArtifactsDelete operation in PublicApi.
2508
- * @export
2509
- * @interface PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest
2510
- */
2511
- interface PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest {
2512
- /**
2513
- * Run id, returned by &#x60;POST /runs/&#x60; endpoint
2514
- * @type {string}
2515
- * @memberof PublicApiDeleteRunItemsV1RunsRunIdArtifactsDelete
2516
- */
2517
- readonly runId: string;
2518
- }
2519
- /**
2520
- * Request parameters for getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet operation in PublicApi.
2521
- * @export
2522
- * @interface PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest
2523
- */
2524
- interface PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest {
2525
- /**
2526
- * Run id, returned by &#x60;POST /runs/&#x60; endpoint
2527
- * @type {string}
2528
- * @memberof PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet
2529
- */
2530
- readonly runId: string;
2531
- /**
2532
- * The artifact id to download
2533
- * @type {string}
2534
- * @memberof PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet
2535
- */
2536
- readonly artifactId: string;
2537
- /**
2538
- * Share token for accessing shared runs
2539
- * @type {string}
2540
- * @memberof PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet
2541
- */
2542
- readonly shareToken?: string | null;
2543
- }
2544
- /**
2545
- * Request parameters for getGrantV1AccessGrantsGrantIdGet operation in PublicApi.
2546
- * @export
2547
- * @interface PublicApiGetGrantV1AccessGrantsGrantIdGetRequest
2548
- */
2549
- interface PublicApiGetGrantV1AccessGrantsGrantIdGetRequest {
2550
- /**
2551
- * Grant ID
2552
- * @type {string}
2553
- * @memberof PublicApiGetGrantV1AccessGrantsGrantIdGet
2554
- */
2555
- readonly grantId: string;
2556
- }
2557
- /**
2558
- * Request parameters for getItemByRunV1RunsRunIdItemsExternalIdGet operation in PublicApi.
2559
- * @export
2560
- * @interface PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest
2561
- */
2562
- interface PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest {
2563
- /**
2564
- * The run id, returned by &#x60;POST /runs/&#x60; endpoint
2565
- * @type {string}
2566
- * @memberof PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGet
2567
- */
2568
- readonly runId: string;
2569
- /**
2570
- * The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
2571
- * @type {string}
2572
- * @memberof PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGet
2573
- */
2574
- readonly externalId: string;
2575
- /**
2576
- * Share token for accessing shared runs
2577
- * @type {string}
2578
- * @memberof PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGet
2579
- */
2580
- readonly shareToken?: string | null;
2581
- }
2582
- /**
2583
- * Request parameters for getRunV1RunsRunIdGet operation in PublicApi.
2584
- * @export
2585
- * @interface PublicApiGetRunV1RunsRunIdGetRequest
2586
- */
2587
- interface PublicApiGetRunV1RunsRunIdGetRequest {
2588
- /**
2589
- * Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
2590
- * @type {string}
2591
- * @memberof PublicApiGetRunV1RunsRunIdGet
2592
- */
2593
- readonly runId: string;
2594
- /**
2595
- * Share token for accessing shared runs
2596
- * @type {string}
2597
- * @memberof PublicApiGetRunV1RunsRunIdGet
2598
- */
2599
- readonly shareToken?: string | null;
2600
- }
2601
- /**
2602
- * Request parameters for getShareTokenV1AccessShareTokensShareTokenIdGet operation in PublicApi.
2603
- * @export
2604
- * @interface PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest
2605
- */
2606
- interface PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest {
2607
- /**
2608
- * Share token ID
2609
- * @type {string}
2610
- * @memberof PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGet
2611
- */
2612
- readonly shareTokenId: string;
2613
- }
2614
- /**
2615
- * Request parameters for getVersionDocument operation in PublicApi.
2616
- * @export
2617
- * @interface PublicApiGetVersionDocumentRequest
2618
- */
2619
- interface PublicApiGetVersionDocumentRequest {
2620
- /**
2621
- *
2622
- * @type {string}
2623
- * @memberof PublicApiGetVersionDocument
2624
- */
2625
- readonly applicationId: string;
2626
- /**
2627
- *
2628
- * @type {string}
2629
- * @memberof PublicApiGetVersionDocument
2630
- */
2631
- readonly version: string;
2632
- /**
2633
- *
2634
- * @type {string}
2635
- * @memberof PublicApiGetVersionDocument
2636
- */
2637
- readonly name: string;
2638
- }
2639
- /**
2640
- * Request parameters for getVersionDocumentContent operation in PublicApi.
2641
- * @export
2642
- * @interface PublicApiGetVersionDocumentContentRequest
2643
- */
2644
- interface PublicApiGetVersionDocumentContentRequest {
2645
- /**
2646
- *
2647
- * @type {string}
2648
- * @memberof PublicApiGetVersionDocumentContent
2649
- */
2650
- readonly applicationId: string;
2651
- /**
2652
- *
2653
- * @type {string}
2654
- * @memberof PublicApiGetVersionDocumentContent
2655
- */
2656
- readonly version: string;
2657
- /**
2658
- *
2659
- * @type {string}
2660
- * @memberof PublicApiGetVersionDocumentContent
2661
- */
2662
- readonly name: string;
2663
- }
2664
- /**
2665
- * Request parameters for getVersionDocumentFile operation in PublicApi.
2666
- * @export
2667
- * @interface PublicApiGetVersionDocumentFileRequest
2668
- */
2669
- interface PublicApiGetVersionDocumentFileRequest {
2670
- /**
2671
- *
2672
- * @type {string}
2673
- * @memberof PublicApiGetVersionDocumentFile
2674
- */
2675
- readonly applicationId: string;
2676
- /**
2677
- *
2678
- * @type {string}
2679
- * @memberof PublicApiGetVersionDocumentFile
2680
- */
2681
- readonly version: string;
2682
- /**
2683
- *
2684
- * @type {string}
2685
- * @memberof PublicApiGetVersionDocumentFile
2686
- */
2687
- readonly name: string;
2688
- }
2689
- /**
2690
- * Request parameters for listApplicationsV1ApplicationsGet operation in PublicApi.
2691
- * @export
2692
- * @interface PublicApiListApplicationsV1ApplicationsGetRequest
2693
- */
2694
- interface PublicApiListApplicationsV1ApplicationsGetRequest {
2695
- /**
2696
- *
2697
- * @type {number}
2698
- * @memberof PublicApiListApplicationsV1ApplicationsGet
2699
- */
2700
- readonly page?: number;
2701
- /**
2702
- *
2703
- * @type {number}
2704
- * @memberof PublicApiListApplicationsV1ApplicationsGet
2705
- */
2706
- readonly pageSize?: number;
2707
- /**
2708
- * Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;application_id&#x60; - &#x60;name&#x60; - &#x60;description&#x60; - &#x60;regulatory_classes&#x60; **Examples:** - &#x60;?sort&#x3D;application_id&#x60; - Sort by application_id ascending - &#x60;?sort&#x3D;-name&#x60; - Sort by name descending - &#x60;?sort&#x3D;+description&amp;sort&#x3D;name&#x60; - Sort by description ascending, then name descending
2709
- * @type {Array<string>}
2710
- * @memberof PublicApiListApplicationsV1ApplicationsGet
2711
- */
2712
- readonly sort?: Array<string> | null;
2713
- }
2714
- /**
2715
- * Request parameters for listGrantsV1AccessGrantsGet operation in PublicApi.
2716
- * @export
2717
- * @interface PublicApiListGrantsV1AccessGrantsGetRequest
2718
- */
2719
- interface PublicApiListGrantsV1AccessGrantsGetRequest {
2720
- /**
2721
- *
2722
- * @type {ResourceType}
2723
- * @memberof PublicApiListGrantsV1AccessGrantsGet
2724
- */
2725
- readonly resourceType?: ResourceType | null;
2726
- /**
2727
- *
2728
- * @type {string}
2729
- * @memberof PublicApiListGrantsV1AccessGrantsGet
2730
- */
2731
- readonly resourceId?: string | null;
2732
- /**
2733
- *
2734
- * @type {SubjectType}
2735
- * @memberof PublicApiListGrantsV1AccessGrantsGet
2736
- */
2737
- readonly subjectType?: SubjectType | null;
2738
- /**
2739
- *
2740
- * @type {string}
2741
- * @memberof PublicApiListGrantsV1AccessGrantsGet
2742
- */
2743
- readonly subjectId?: string | null;
2744
- /**
2745
- * Filter grants by relation type. Can be specified multiple times.
2746
- * @type {Array<GrantRelation>}
2747
- * @memberof PublicApiListGrantsV1AccessGrantsGet
2748
- */
2749
- readonly relation?: Array<GrantRelation> | null;
2750
- /**
2751
- *
2752
- * @type {boolean}
2753
- * @memberof PublicApiListGrantsV1AccessGrantsGet
2754
- */
2755
- readonly revoked?: boolean | null;
2756
- /**
2757
- *
2758
- * @type {number}
2759
- * @memberof PublicApiListGrantsV1AccessGrantsGet
2760
- */
2761
- readonly page?: number;
2762
- /**
2763
- *
2764
- * @type {number}
2765
- * @memberof PublicApiListGrantsV1AccessGrantsGet
2766
- */
2767
- readonly pageSize?: number;
2768
- /**
2769
- * Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
2770
- * @type {Array<string>}
2771
- * @memberof PublicApiListGrantsV1AccessGrantsGet
2772
- */
2773
- readonly sort?: Array<string> | null;
2774
- }
2775
- /**
2776
- * Request parameters for listRunItemsV1RunsRunIdItemsGet operation in PublicApi.
2777
- * @export
2778
- * @interface PublicApiListRunItemsV1RunsRunIdItemsGetRequest
2779
- */
2780
- interface PublicApiListRunItemsV1RunsRunIdItemsGetRequest {
2781
- /**
2782
- * Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
2783
- * @type {string}
2784
- * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
2785
- */
2786
- readonly runId: string;
2787
- /**
2788
- * Share token for accessing shared runs
2789
- * @type {string}
2790
- * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
2791
- */
2792
- readonly shareToken?: string | null;
2793
- /**
2794
- * Filter for item ids
2795
- * @type {Array<string>}
2796
- * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
2797
- */
2798
- readonly itemIdIn?: Array<string> | null;
2799
- /**
2800
- * Filter for items by their external_id from the input payload
2801
- * @type {Array<string>}
2802
- * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
2803
- */
2804
- readonly externalIdIn?: Array<string> | null;
2805
- /**
2806
- * Filter items by their state
2807
- * @type {ItemState}
2808
- * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
2809
- */
2810
- readonly state?: ItemState | null;
2811
- /**
2812
- * Filter items by their termination reason. Only applies to TERMINATED items.
2813
- * @type {ItemTerminationReason}
2814
- * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
2815
- */
2816
- readonly terminationReason?: ItemTerminationReason | null;
2817
- /**
2818
- * JSONPath expression to filter items by their custom_metadata
2819
- * @type {string}
2820
- * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
2821
- */
2822
- readonly customMetadata?: string | null;
2823
- /**
2824
- *
2825
- * @type {number}
2826
- * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
2827
- */
2828
- readonly page?: number;
2829
- /**
2830
- *
2831
- * @type {number}
2832
- * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
2833
- */
2834
- readonly pageSize?: number;
2835
- /**
2836
- * Sort the items by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;item_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;item_id&#x60; - Sort by id of the item (ascending) - &#x60;?sort&#x3D;-external_id&#x60; - Sort by external ID (descending) - &#x60;?sort&#x3D;custom_metadata&amp;sort&#x3D;-external_id&#x60; - Sort by metadata, then by external ID (descending)
2837
- * @type {Array<string>}
2838
- * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
2839
- */
2840
- readonly sort?: Array<string> | null;
2841
- }
2842
- /**
2843
- * Request parameters for listRunsV1RunsGet operation in PublicApi.
2844
- * @export
2845
- * @interface PublicApiListRunsV1RunsGetRequest
2846
- */
2847
- interface PublicApiListRunsV1RunsGetRequest {
2848
- /**
2849
- * Optional application ID filter
2850
- * @type {string}
2851
- * @memberof PublicApiListRunsV1RunsGet
2852
- */
2853
- readonly applicationId?: string | null;
2854
- /**
2855
- * Optional Version Name
2856
- * @type {string}
2857
- * @memberof PublicApiListRunsV1RunsGet
2858
- */
2859
- readonly applicationVersion?: string | null;
2860
- /**
2861
- * Optionally filter runs by items with this external ID
2862
- * @type {string}
2863
- * @memberof PublicApiListRunsV1RunsGet
2864
- */
2865
- readonly externalId?: string | null;
2866
- /**
2867
- * Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: &#x60;$.study&#x60; - Runs that have a study field defined - **Exact value match**: &#x60;$.study ? (@ &#x3D;&#x3D; \&quot;high\&quot;)&#x60; - Runs with specific study value - **Numeric comparison**: &#x60;$.confidence_score ? (@ &gt; 0.75)&#x60; - Runs with confidence score greater than 0.75 - **Array operations**: &#x60;$.tags[*] ? (@ &#x3D;&#x3D; \&quot;draft\&quot;)&#x60; - Runs with tags array containing \&quot;draft\&quot; - **Complex conditions**: &#x60;$.resources ? (@.gpu_count &gt; 2 &amp;&amp; @.memory_gb &gt;&#x3D; 16)&#x60; - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: &#x60;%24.study&#x60; - **Exact value match**: &#x60;%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)&#x60; - **Numeric comparison**: &#x60;%24.confidence_score%20%3F%20(%40%20%3E%200.75)&#x60; - **Array operations**: &#x60;%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)&#x60; - **Complex conditions**: &#x60;%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)&#x60; #### Notes - JSONPath expressions are evaluated using PostgreSQL\&#39;s &#x60;@?&#x60; operator - The &#x60;$.&#x60; prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use &#x60;&amp;&amp;&#x60; for AND operations and &#x60;||&#x60; for OR operations - Regular expressions use &#x60;like_regex&#x60; with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
2868
- * @type {string}
2869
- * @memberof PublicApiListRunsV1RunsGet
2870
- */
2871
- readonly customMetadata?: string | null;
2872
- /**
2873
- *
2874
- * @type {number}
2875
- * @memberof PublicApiListRunsV1RunsGet
2876
- */
2877
- readonly page?: number;
2878
- /**
2879
- *
2880
- * @type {number}
2881
- * @memberof PublicApiListRunsV1RunsGet
2882
- */
2883
- readonly pageSize?: number;
2884
- /**
2885
- * Filter runs by the user who submitted them. Use the special value &#x60;me&#x60; to return only runs submitted by the current user.
2886
- * @type {string}
2887
- * @memberof PublicApiListRunsV1RunsGet
2888
- */
2889
- readonly submittedBy?: string | null;
2890
- /**
2891
- * Filter runs by the organization of the submitter. Use the special value &#x60;my_org&#x60; to filter by the current user\&#39;s organization.
2892
- * @type {string}
2893
- * @memberof PublicApiListRunsV1RunsGet
2894
- */
2895
- readonly organizationId?: string | null;
2896
- /**
2897
- * Filter runs by organization ID. Available for superadmins (any org) and admins (own org only). When provided, returns all runs for the specified organization instead of only the caller\&#39;s own runs.
2898
- * @type {string}
2899
- * @memberof PublicApiListRunsV1RunsGet
2900
- */
2901
- readonly forOrganization?: string | null;
2902
- /**
2903
- * Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;run_id&#x60; - &#x60;application_id&#x60; - &#x60;version_number&#x60; - &#x60;custom_metadata&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;submitted_at&#x60; - Sort by creation time (ascending) - &#x60;?sort&#x3D;-submitted_at&#x60; - Sort by creation time (descending) - &#x60;?sort&#x3D;state&amp;sort&#x3D;-submitted_at&#x60; - Sort by state, then by time (descending)
2904
- * @type {Array<string>}
2905
- * @memberof PublicApiListRunsV1RunsGet
2906
- */
2907
- readonly sort?: Array<string> | null;
2908
- }
2909
- /**
2910
- * Request parameters for listShareTokensV1AccessShareTokensGet operation in PublicApi.
2911
- * @export
2912
- * @interface PublicApiListShareTokensV1AccessShareTokensGetRequest
2913
- */
2914
- interface PublicApiListShareTokensV1AccessShareTokensGetRequest {
2915
- /**
2916
- * Filter by run ID
2917
- * @type {string}
2918
- * @memberof PublicApiListShareTokensV1AccessShareTokensGet
2919
- */
2920
- readonly runId?: string | null;
2921
- /**
2922
- * Filter by share token creator
2923
- * @type {string}
2924
- * @memberof PublicApiListShareTokensV1AccessShareTokensGet
2925
- */
2926
- readonly createdBy?: string | null;
2927
- /**
2928
- *
2929
- * @type {boolean}
2930
- * @memberof PublicApiListShareTokensV1AccessShareTokensGet
2931
- */
2932
- readonly revoked?: boolean | null;
2933
- /**
2934
- *
2935
- * @type {number}
2936
- * @memberof PublicApiListShareTokensV1AccessShareTokensGet
2937
- */
2938
- readonly page?: number;
2939
- /**
2940
- *
2941
- * @type {number}
2942
- * @memberof PublicApiListShareTokensV1AccessShareTokensGet
2943
- */
2944
- readonly pageSize?: number;
2945
- /**
2946
- * Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
2947
- * @type {Array<string>}
2948
- * @memberof PublicApiListShareTokensV1AccessShareTokensGet
2949
- */
2950
- readonly sort?: Array<string> | null;
2951
- }
2952
- /**
2953
- * Request parameters for listVersionDocuments operation in PublicApi.
2954
- * @export
2955
- * @interface PublicApiListVersionDocumentsRequest
2956
- */
2957
- interface PublicApiListVersionDocumentsRequest {
2958
- /**
2959
- *
2960
- * @type {string}
2961
- * @memberof PublicApiListVersionDocuments
2962
- */
2963
- readonly applicationId: string;
2964
- /**
2965
- *
2966
- * @type {string}
2967
- * @memberof PublicApiListVersionDocuments
2968
- */
2969
- readonly version: string;
2970
- }
2971
- /**
2972
- * Request parameters for putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut operation in PublicApi.
2973
- * @export
2974
- * @interface PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest
2975
- */
2976
- interface PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest {
2977
- /**
2978
- * The run id, returned by &#x60;POST /runs/&#x60; endpoint
2979
- * @type {string}
2980
- * @memberof PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut
2981
- */
2982
- readonly runId: string;
2983
- /**
2984
- * The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
2985
- * @type {string}
2986
- * @memberof PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut
2987
- */
2988
- readonly externalId: string;
2989
- /**
2990
- *
2991
- * @type {CustomMetadataUpdateRequest}
2992
- * @memberof PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut
2993
- */
2994
- readonly customMetadataUpdateRequest: CustomMetadataUpdateRequest;
2995
- }
2996
- /**
2997
- * Request parameters for putRunCustomMetadataV1RunsRunIdCustomMetadataPut operation in PublicApi.
2998
- * @export
2999
- * @interface PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest
3000
- */
3001
- interface PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest {
3002
- /**
3003
- * Run id, returned by &#x60;POST /runs/&#x60; endpoint
3004
- * @type {string}
3005
- * @memberof PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPut
3006
- */
3007
- readonly runId: string;
3008
- /**
3009
- *
3010
- * @type {CustomMetadataUpdateRequest}
3011
- * @memberof PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPut
3012
- */
3013
- readonly customMetadataUpdateRequest: CustomMetadataUpdateRequest;
3014
- }
3015
- /**
3016
- * Request parameters for readApplicationByIdV1ApplicationsApplicationIdGet operation in PublicApi.
3017
- * @export
3018
- * @interface PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest
3019
- */
3020
- interface PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest {
3021
- /**
3022
- *
3023
- * @type {string}
3024
- * @memberof PublicApiReadApplicationByIdV1ApplicationsApplicationIdGet
3025
- */
3026
- readonly applicationId: string;
3027
- }
3028
- /**
3029
- * Request parameters for revokeGrantV1AccessGrantsGrantIdDelete operation in PublicApi.
3030
- * @export
3031
- * @interface PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest
3032
- */
3033
- interface PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest {
3034
- /**
3035
- * Grant ID
3036
- * @type {string}
3037
- * @memberof PublicApiRevokeGrantV1AccessGrantsGrantIdDelete
3038
- */
3039
- readonly grantId: string;
3040
- }
3041
- /**
3042
- * Request parameters for revokeShareTokenV1AccessShareTokensShareTokenIdDelete operation in PublicApi.
3043
- * @export
3044
- * @interface PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest
3045
- */
3046
- interface PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest {
3047
- /**
3048
- * Share token ID
3049
- * @type {string}
3050
- * @memberof PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDelete
3051
- */
3052
- readonly shareTokenId: string;
3053
- }
3054
- /**
3055
- * PublicApi - object-oriented interface
3056
- * @export
3057
- * @class PublicApi
3058
- * @extends {BaseAPI}
3059
- */
3060
- declare class PublicApi extends BaseAPI implements PublicApiInterface {
3061
- /**
3062
- * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
3063
- * @summary Application Version Details
3064
- * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
3065
- * @param {*} [options] Override http request option.
3066
- * @throws {RequiredError}
3067
- * @memberof PublicApi
3068
- */
3069
- applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionReadResponse, any, {}>>;
3070
- /**
3071
- * The run can be canceled by the user who created the run. The execution can be canceled any time while the run is not in the terminated state. The pending items of a canceled run will not be processed and will not add to the cost. When the run is canceled, the already completed items remain available for download.
3072
- * @summary Cancel Run
3073
- * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
3074
- * @param {*} [options] Override http request option.
3075
- * @throws {RequiredError}
3076
- * @memberof PublicApi
3077
- */
3078
- cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
3079
- /**
3080
- * Create a grant to share access to a resource with a subject (user or organization).
3081
- * @summary Create Grant
3082
- * @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
3083
- * @param {*} [options] Override http request option.
3084
- * @throws {RequiredError}
3085
- * @memberof PublicApi
3086
- */
3087
- createGrantV1AccessGrantsPost(requestParameters: PublicApiCreateGrantV1AccessGrantsPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse, any, {}>>;
3088
- /**
3089
- * This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
3090
- * @summary Initiate Run
3091
- * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
3092
- * @param {*} [options] Override http request option.
3093
- * @throws {RequiredError}
3094
- * @memberof PublicApi
3095
- */
3096
- createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunCreationResponse, any, {}>>;
3097
- /**
3098
- * Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
3099
- * @summary Create Share Token
3100
- * @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
3101
- * @param {*} [options] Override http request option.
3102
- * @throws {RequiredError}
3103
- * @memberof PublicApi
3104
- */
3105
- createShareTokenV1AccessShareTokensPost(requestParameters: PublicApiCreateShareTokenV1AccessShareTokensPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenCreateResponse, any, {}>>;
3106
- /**
3107
- * This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
3108
- * @summary Delete Run Items
3109
- * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
3110
- * @param {*} [options] Override http request option.
3111
- * @throws {RequiredError}
3112
- * @memberof PublicApi
3113
- */
3114
- deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
3115
- /**
3116
- * Download the artifact file with the specified artifact_id, belonging to the specified run. The artifact_is is returned by the `GET /v1/runs/{run_id}/items` endpoint as part of the item results, and can also be retrieved via `GET /v1/runs/{run_id}/items/{external_id}`. The endpoint may return a redirect response with a presigned URL to download the artifact file from the storage bucket. The presigned URL is valid for a limited time, so it should be used immediately after receiving the response.
3117
- * @summary Get Artifact Url
3118
- * @param {PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest} requestParameters Request parameters.
3119
- * @param {*} [options] Override http request option.
3120
- * @throws {RequiredError}
3121
- * @memberof PublicApi
3122
- */
3123
- getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
3124
- /**
3125
- * Get a grant by its ID.
3126
- * @summary Get Grant
3127
- * @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
3128
- * @param {*} [options] Override http request option.
3129
- * @throws {RequiredError}
3130
- * @memberof PublicApi
3131
- */
3132
- getGrantV1AccessGrantsGrantIdGet(requestParameters: PublicApiGetGrantV1AccessGrantsGrantIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse, any, {}>>;
3133
- /**
3134
- * Retrieve details of a specific item (slide) by its external ID and the run ID.
3135
- * @summary Get Item By Run
3136
- * @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
3137
- * @param {*} [options] Override http request option.
3138
- * @throws {RequiredError}
3139
- * @memberof PublicApi
3140
- */
3141
- getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters: PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ItemResultReadResponse, any, {}>>;
3142
- /**
3143
- * Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
3144
- * @summary Get current user
3145
- * @param {*} [options] Override http request option.
3146
- * @throws {RequiredError}
3147
- * @memberof PublicApi
3148
- */
3149
- getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<MeReadResponse, any, {}>>;
3150
- /**
3151
- * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
3152
- * @summary Get run details
3153
- * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
3154
- * @param {*} [options] Override http request option.
3155
- * @throws {RequiredError}
3156
- * @memberof PublicApi
3157
- */
3158
- getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse, any, {}>>;
3159
- /**
3160
- * Get a share token by its ID.
3161
- * @summary Get Share Token
3162
- * @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
3163
- * @param {*} [options] Override http request option.
3164
- * @throws {RequiredError}
3165
- * @memberof PublicApi
3166
- */
3167
- getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters: PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenReadResponse, any, {}>>;
3168
- /**
3169
- * Return metadata for a single public document attached to an application version.
3170
- * @summary Get version document metadata
3171
- * @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
3172
- * @param {*} [options] Override http request option.
3173
- * @throws {RequiredError}
3174
- * @memberof PublicApi
3175
- */
3176
- getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionDocumentResponse, any, {}>>;
3177
- /**
3178
- * 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
3179
- * @summary Stream version document content (programmatic)
3180
- * @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
3181
- * @param {*} [options] Override http request option.
3182
- * @throws {RequiredError}
3183
- * @memberof PublicApi
3184
- */
3185
- getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
3186
- /**
3187
- * 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
3188
- * @summary Download version document (browser)
3189
- * @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
3190
- * @param {*} [options] Override http request option.
3191
- * @throws {RequiredError}
3192
- * @memberof PublicApi
3193
- */
3194
- getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
3195
- /**
3196
- * Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
3197
- * @summary List available applications
3198
- * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
3199
- * @param {*} [options] Override http request option.
3200
- * @throws {RequiredError}
3201
- * @memberof PublicApi
3202
- */
3203
- listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadShortResponse[], any, {}>>;
3204
- /**
3205
- * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
3206
- * @summary List Grants
3207
- * @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
3208
- * @param {*} [options] Override http request option.
3209
- * @throws {RequiredError}
3210
- * @memberof PublicApi
3211
- */
3212
- listGrantsV1AccessGrantsGet(requestParameters?: PublicApiListGrantsV1AccessGrantsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse[], any, {}>>;
3213
- /**
3214
- * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
3215
- * @summary List Run Items
3216
- * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
3217
- * @param {*} [options] Override http request option.
3218
- * @throws {RequiredError}
3219
- * @memberof PublicApi
3220
- */
3221
- listRunItemsV1RunsRunIdItemsGet(requestParameters: PublicApiListRunItemsV1RunsRunIdItemsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ItemResultReadResponse[], any, {}>>;
3222
- /**
3223
- * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
3224
- * @summary List Runs
3225
- * @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
3226
- * @param {*} [options] Override http request option.
3227
- * @throws {RequiredError}
3228
- * @memberof PublicApi
3229
- */
3230
- listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse[], any, {}>>;
3231
- /**
3232
- * List share tokens. Service and Superadmin see all tokens; other users see only their own.
3233
- * @summary List Share Tokens
3234
- * @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
3235
- * @param {*} [options] Override http request option.
3236
- * @throws {RequiredError}
3237
- * @memberof PublicApi
3238
- */
3239
- listShareTokensV1AccessShareTokensGet(requestParameters?: PublicApiListShareTokensV1AccessShareTokensGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenReadResponse[], any, {}>>;
3240
- /**
3241
- * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
3242
- * @summary List version documents
3243
- * @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
3244
- * @param {*} [options] Override http request option.
3245
- * @throws {RequiredError}
3246
- * @memberof PublicApi
3247
- */
3248
- listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionDocumentResponse[], any, {}>>;
3249
- /**
3250
- * Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
3251
- * @summary Put Item Custom Metadata By Run
3252
- * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
3253
- * @param {*} [options] Override http request option.
3254
- * @throws {RequiredError}
3255
- * @memberof PublicApi
3256
- */
3257
- putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CustomMetadataUpdateResponse, any, {}>>;
3258
- /**
3259
- * Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
3260
- * @summary Put Run Custom Metadata
3261
- * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
3262
- * @param {*} [options] Override http request option.
3263
- * @throws {RequiredError}
3264
- * @memberof PublicApi
3265
- */
3266
- putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CustomMetadataUpdateResponse, any, {}>>;
3267
- /**
3268
- * Retrieve details of a specific application by its ID.
3269
- * @summary Read Application By Id
3270
- * @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
3271
- * @param {*} [options] Override http request option.
3272
- * @throws {RequiredError}
3273
- * @memberof PublicApi
3274
- */
3275
- readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadResponse, any, {}>>;
3276
- /**
3277
- * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
3278
- * @summary Revoke Grant
3279
- * @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
3280
- * @param {*} [options] Override http request option.
3281
- * @throws {RequiredError}
3282
- * @memberof PublicApi
3283
- */
3284
- revokeGrantV1AccessGrantsGrantIdDelete(requestParameters: PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse, any, {}>>;
3285
- /**
3286
- * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
3287
- * @summary Revoke Share Token
3288
- * @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
3289
- * @param {*} [options] Override http request option.
3290
- * @throws {RequiredError}
3291
- * @memberof PublicApi
3292
- */
3293
- revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters: PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenReadResponse, any, {}>>;
3294
- }
3295
-
3296
- export { type PublicApiCreateRunV1RunsPostRequest as $, type ApplicationReadShortResponse as A, type SchedulingResponse as B, type CustomMetadataUpdateRequest as C, type ShareTokenCreateRequest as D, type ShareTokenCreateResponse as E, type ShareTokenReadResponse as F, type GrantCreateRequest as G, type HTTPValidationError as H, type ItemResultReadResponse as I, SubjectType as J, type ValidationError as K, type ValidationErrorLocInner as L, type MeReadResponse as M, type VersionDocumentResponse as N, type OrganizationReadResponse as O, VersionDocumentVisibility as P, PublicApiAxiosParamCreator as Q, type RunReadResponse as R, type SchedulingRequest as S, PublicApiFp as T, type UserReadResponse as U, type VersionReadResponse as V, PublicApiFactory as W, type PublicApiInterface as X, type PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest as Y, type PublicApiCancelRunV1RunsRunIdCancelPostRequest as Z, type PublicApiCreateGrantV1AccessGrantsPostRequest as _, type ApplicationReadResponse as a, type PublicApiCreateShareTokenV1AccessShareTokensPostRequest as a0, type PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest as a1, type PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest as a2, type PublicApiGetGrantV1AccessGrantsGrantIdGetRequest as a3, type PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest as a4, type PublicApiGetRunV1RunsRunIdGetRequest as a5, type PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest as a6, type PublicApiGetVersionDocumentRequest as a7, type PublicApiGetVersionDocumentContentRequest as a8, type PublicApiGetVersionDocumentFileRequest as a9, type PublicApiListApplicationsV1ApplicationsGetRequest as aa, type PublicApiListGrantsV1AccessGrantsGetRequest as ab, type PublicApiListRunItemsV1RunsRunIdItemsGetRequest as ac, type PublicApiListRunsV1RunsGetRequest as ad, type PublicApiListShareTokensV1AccessShareTokensGetRequest as ae, type PublicApiListVersionDocumentsRequest as af, type PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest as ag, type PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest as ah, type PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest as ai, type PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest as aj, type PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest as ak, PublicApi as al, type ConfigurationParameters as am, Configuration as an, type RunCreationRequest as b, type RunCreationResponse as c, ItemState as d, ItemTerminationReason as e, type ApplicationVersion as f, ArtifactOutput as g, ArtifactState as h, ArtifactTerminationReason as i, type CustomMetadataUpdateResponse as j, type GrantReadResponse as k, GrantRelation as l, type InputArtifact as m, type InputArtifactCreationRequest as n, type InputArtifactResultReadResponse as o, type ItemCreationRequest as p, ItemOutput as q, type OutputArtifact as r, type OutputArtifactResultReadResponse as s, OutputArtifactScope as t, OutputArtifactVisibility as u, ResourceType as v, type RunItemStatistics as w, RunOutput as x, RunState as y, RunTerminationReason as z };