@aignostics/sdk 2.3.1 → 3.1.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.
@@ -0,0 +1,1951 @@
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.0.1
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.0.1
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 {object}
266
+ * @memberof CustomMetadataUpdateRequest
267
+ */
268
+ 'custom_metadata'?: object | null;
269
+ /**
270
+ *
271
+ * @type {string}
272
+ * @memberof CustomMetadataUpdateRequest
273
+ */
274
+ 'custom_metadata_checksum'?: string | null;
275
+ }
276
+ /**
277
+ *
278
+ * @export
279
+ * @interface CustomMetadataUpdateResponse
280
+ */
281
+ interface CustomMetadataUpdateResponse {
282
+ /**
283
+ *
284
+ * @type {string}
285
+ * @memberof CustomMetadataUpdateResponse
286
+ */
287
+ 'custom_metadata_checksum': string | null;
288
+ }
289
+ /**
290
+ *
291
+ * @export
292
+ * @interface HTTPValidationError
293
+ */
294
+ interface HTTPValidationError {
295
+ /**
296
+ *
297
+ * @type {Array<ValidationError>}
298
+ * @memberof HTTPValidationError
299
+ */
300
+ 'detail'?: Array<ValidationError>;
301
+ }
302
+ /**
303
+ *
304
+ * @export
305
+ * @interface InputArtifact
306
+ */
307
+ interface InputArtifact {
308
+ /**
309
+ *
310
+ * @type {string}
311
+ * @memberof InputArtifact
312
+ */
313
+ 'name': string;
314
+ /**
315
+ *
316
+ * @type {string}
317
+ * @memberof InputArtifact
318
+ */
319
+ 'mime_type': string;
320
+ /**
321
+ *
322
+ * @type {object}
323
+ * @memberof InputArtifact
324
+ */
325
+ 'metadata_schema': object;
326
+ }
327
+ /**
328
+ * Input artifact containing the slide image and associated metadata.
329
+ * @export
330
+ * @interface InputArtifactCreationRequest
331
+ */
332
+ interface InputArtifactCreationRequest {
333
+ /**
334
+ * Type of artifact. For Atlas H&E-TME, use \"input_slide\"
335
+ * @type {string}
336
+ * @memberof InputArtifactCreationRequest
337
+ */
338
+ 'name': string;
339
+ /**
340
+ * [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.
341
+ * @type {string}
342
+ * @memberof InputArtifactCreationRequest
343
+ */
344
+ 'download_url': string;
345
+ /**
346
+ * 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`
347
+ * @type {object}
348
+ * @memberof InputArtifactCreationRequest
349
+ */
350
+ 'metadata': object;
351
+ }
352
+ /**
353
+ * Individual item (slide) to be processed in a run.
354
+ * @export
355
+ * @interface ItemCreationRequest
356
+ */
357
+ interface ItemCreationRequest {
358
+ /**
359
+ * Unique identifier for this item within the run. Used for referencing items. Must be unique across all items in the same run
360
+ * @type {string}
361
+ * @memberof ItemCreationRequest
362
+ */
363
+ 'external_id': string;
364
+ /**
365
+ *
366
+ * @type {object}
367
+ * @memberof ItemCreationRequest
368
+ */
369
+ 'custom_metadata'?: object | null;
370
+ /**
371
+ * List of input artifacts for this item. For Atlas H&E-TME, typically contains one artifact (the slide image)
372
+ * @type {Array<InputArtifactCreationRequest>}
373
+ * @memberof ItemCreationRequest
374
+ */
375
+ 'input_artifacts': Array<InputArtifactCreationRequest>;
376
+ }
377
+ /**
378
+ *
379
+ * @export
380
+ * @enum {string}
381
+ */
382
+ declare const ItemOutput: {
383
+ readonly None: "NONE";
384
+ readonly Full: "FULL";
385
+ };
386
+ type ItemOutput = typeof ItemOutput[keyof typeof ItemOutput];
387
+ /**
388
+ * Response schema for items in `List Run Items` endpoint
389
+ * @export
390
+ * @interface ItemResultReadResponse
391
+ */
392
+ interface ItemResultReadResponse {
393
+ /**
394
+ * Item UUID generated by the Platform
395
+ * @type {string}
396
+ * @memberof ItemResultReadResponse
397
+ */
398
+ 'item_id': string;
399
+ /**
400
+ * The external_id of the item from the user payload
401
+ * @type {string}
402
+ * @memberof ItemResultReadResponse
403
+ */
404
+ 'external_id': string;
405
+ /**
406
+ *
407
+ * @type {object}
408
+ * @memberof ItemResultReadResponse
409
+ */
410
+ 'custom_metadata': object | null;
411
+ /**
412
+ *
413
+ * @type {string}
414
+ * @memberof ItemResultReadResponse
415
+ */
416
+ 'custom_metadata_checksum'?: string | null;
417
+ /**
418
+ *
419
+ * @type {number}
420
+ * @memberof ItemResultReadResponse
421
+ */
422
+ 'queue_position_org'?: number | null;
423
+ /**
424
+ *
425
+ * @type {number}
426
+ * @memberof ItemResultReadResponse
427
+ */
428
+ 'queue_position_platform'?: number | null;
429
+ /**
430
+ * The item moves from `PENDING` to `PROCESSING` to `TERMINATED` state. When terminated, consult the `termination_reason` property to see whether it was successful.
431
+ * @type {ItemState}
432
+ * @memberof ItemResultReadResponse
433
+ */
434
+ 'state': ItemState;
435
+ /**
436
+ * The output status of the item (NONE, FULL)
437
+ * @type {ItemOutput}
438
+ * @memberof ItemResultReadResponse
439
+ */
440
+ 'output': ItemOutput;
441
+ /**
442
+ *
443
+ * @type {ItemTerminationReason}
444
+ * @memberof ItemResultReadResponse
445
+ */
446
+ 'termination_reason'?: ItemTerminationReason | null;
447
+ /**
448
+ *
449
+ * @type {string}
450
+ * @memberof ItemResultReadResponse
451
+ */
452
+ 'error_message'?: string | null;
453
+ /**
454
+ *
455
+ * @type {string}
456
+ * @memberof ItemResultReadResponse
457
+ */
458
+ 'terminated_at'?: string | null;
459
+ /**
460
+ * 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.
461
+ * @type {Array<OutputArtifactResultReadResponse>}
462
+ * @memberof ItemResultReadResponse
463
+ */
464
+ 'output_artifacts': Array<OutputArtifactResultReadResponse>;
465
+ /**
466
+ *
467
+ * @type {string}
468
+ * @memberof ItemResultReadResponse
469
+ */
470
+ 'error_code': string | null;
471
+ }
472
+ /**
473
+ *
474
+ * @export
475
+ * @enum {string}
476
+ */
477
+ declare const ItemState: {
478
+ readonly Pending: "PENDING";
479
+ readonly Processing: "PROCESSING";
480
+ readonly Terminated: "TERMINATED";
481
+ };
482
+ type ItemState = typeof ItemState[keyof typeof ItemState];
483
+ /**
484
+ *
485
+ * @export
486
+ * @enum {string}
487
+ */
488
+ declare const ItemTerminationReason: {
489
+ readonly Succeeded: "SUCCEEDED";
490
+ readonly UserError: "USER_ERROR";
491
+ readonly SystemError: "SYSTEM_ERROR";
492
+ readonly Skipped: "SKIPPED";
493
+ };
494
+ type ItemTerminationReason = typeof ItemTerminationReason[keyof typeof ItemTerminationReason];
495
+ /**
496
+ * Response schema for `Get current user` endpoint
497
+ * @export
498
+ * @interface MeReadResponse
499
+ */
500
+ interface MeReadResponse {
501
+ /**
502
+ *
503
+ * @type {UserReadResponse}
504
+ * @memberof MeReadResponse
505
+ */
506
+ 'user': UserReadResponse;
507
+ /**
508
+ *
509
+ * @type {OrganizationReadResponse}
510
+ * @memberof MeReadResponse
511
+ */
512
+ 'organization': OrganizationReadResponse;
513
+ }
514
+ /**
515
+ * 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.
516
+ * @export
517
+ * @interface OrganizationReadResponse
518
+ */
519
+ interface OrganizationReadResponse {
520
+ /**
521
+ * Unique organization identifier
522
+ * @type {string}
523
+ * @memberof OrganizationReadResponse
524
+ */
525
+ 'id': string;
526
+ /**
527
+ *
528
+ * @type {string}
529
+ * @memberof OrganizationReadResponse
530
+ */
531
+ 'name'?: string | null;
532
+ /**
533
+ *
534
+ * @type {string}
535
+ * @memberof OrganizationReadResponse
536
+ */
537
+ 'display_name'?: string | null;
538
+ /**
539
+ * HMAC access key ID for the Aignostics-provided storage bucket. Used to authenticate requests for uploading files and generating signed URLs
540
+ * @type {string}
541
+ * @memberof OrganizationReadResponse
542
+ */
543
+ 'aignostics_bucket_hmac_access_key_id': string;
544
+ /**
545
+ * HMAC secret access key paired with the access key ID. Keep this credential secure.
546
+ * @type {string}
547
+ * @memberof OrganizationReadResponse
548
+ */
549
+ 'aignostics_bucket_hmac_secret_access_key': string;
550
+ /**
551
+ * Name of the bucket provided by Aignostics for storing input artifacts (slide images)
552
+ * @type {string}
553
+ * @memberof OrganizationReadResponse
554
+ */
555
+ 'aignostics_bucket_name': string;
556
+ /**
557
+ * Protocol to use for bucket access. Defines the URL scheme for connecting to the storage service
558
+ * @type {string}
559
+ * @memberof OrganizationReadResponse
560
+ */
561
+ 'aignostics_bucket_protocol': string;
562
+ /**
563
+ * Authentication token for Logfire observability service. Enables sending application logs and performance metrics to Aignostics for monitoring and support
564
+ * @type {string}
565
+ * @memberof OrganizationReadResponse
566
+ */
567
+ 'aignostics_logfire_token': string;
568
+ /**
569
+ * Data Source Name (DSN) for Sentry error tracking service. Allows automatic reporting of errors and exceptions to Aignostics support team
570
+ * @type {string}
571
+ * @memberof OrganizationReadResponse
572
+ */
573
+ 'aignostics_sentry_dsn': string;
574
+ }
575
+ /**
576
+ *
577
+ * @export
578
+ * @interface OutputArtifact
579
+ */
580
+ interface OutputArtifact {
581
+ /**
582
+ *
583
+ * @type {string}
584
+ * @memberof OutputArtifact
585
+ */
586
+ 'name': string;
587
+ /**
588
+ *
589
+ * @type {string}
590
+ * @memberof OutputArtifact
591
+ */
592
+ 'mime_type': string;
593
+ /**
594
+ *
595
+ * @type {object}
596
+ * @memberof OutputArtifact
597
+ */
598
+ 'metadata_schema': object;
599
+ /**
600
+ *
601
+ * @type {OutputArtifactScope}
602
+ * @memberof OutputArtifact
603
+ */
604
+ 'scope': OutputArtifactScope;
605
+ /**
606
+ *
607
+ * @type {OutputArtifactVisibility}
608
+ * @memberof OutputArtifact
609
+ */
610
+ 'visibility': OutputArtifactVisibility;
611
+ }
612
+ /**
613
+ *
614
+ * @export
615
+ * @interface OutputArtifactResultReadResponse
616
+ */
617
+ interface OutputArtifactResultReadResponse {
618
+ /**
619
+ * The Id of the artifact. Used internally
620
+ * @type {string}
621
+ * @memberof OutputArtifactResultReadResponse
622
+ */
623
+ 'output_artifact_id': string;
624
+ /**
625
+ * Name of the output from the output schema from the `/v1/versions/{version_id}` endpoint.
626
+ * @type {string}
627
+ * @memberof OutputArtifactResultReadResponse
628
+ */
629
+ 'name': string;
630
+ /**
631
+ *
632
+ * @type {object}
633
+ * @memberof OutputArtifactResultReadResponse
634
+ */
635
+ 'metadata'?: object | null;
636
+ /**
637
+ * The current state of the artifact (PENDING, PROCESSING, TERMINATED)
638
+ * @type {ArtifactState}
639
+ * @memberof OutputArtifactResultReadResponse
640
+ */
641
+ 'state': ArtifactState;
642
+ /**
643
+ *
644
+ * @type {ArtifactTerminationReason}
645
+ * @memberof OutputArtifactResultReadResponse
646
+ */
647
+ 'termination_reason'?: ArtifactTerminationReason | null;
648
+ /**
649
+ * The output status of the artifact (NONE, FULL)
650
+ * @type {ArtifactOutput}
651
+ * @memberof OutputArtifactResultReadResponse
652
+ */
653
+ 'output': ArtifactOutput;
654
+ /**
655
+ *
656
+ * @type {string}
657
+ * @memberof OutputArtifactResultReadResponse
658
+ */
659
+ 'error_message'?: string | null;
660
+ /**
661
+ *
662
+ * @type {string}
663
+ * @memberof OutputArtifactResultReadResponse
664
+ */
665
+ 'download_url': string | null;
666
+ /**
667
+ *
668
+ * @type {string}
669
+ * @memberof OutputArtifactResultReadResponse
670
+ */
671
+ 'error_code': string | null;
672
+ }
673
+ /**
674
+ *
675
+ * @export
676
+ * @enum {string}
677
+ */
678
+ declare const OutputArtifactScope: {
679
+ readonly Item: "ITEM";
680
+ readonly Global: "GLOBAL";
681
+ };
682
+ type OutputArtifactScope = typeof OutputArtifactScope[keyof typeof OutputArtifactScope];
683
+ /**
684
+ *
685
+ * @export
686
+ * @enum {string}
687
+ */
688
+ declare const OutputArtifactVisibility: {
689
+ readonly Internal: "INTERNAL";
690
+ readonly External: "EXTERNAL";
691
+ };
692
+ type OutputArtifactVisibility = typeof OutputArtifactVisibility[keyof typeof OutputArtifactVisibility];
693
+ /**
694
+ * Request schema for `Initiate Run` endpoint. It describes which application version is chosen, and which user data should be processed.
695
+ * @export
696
+ * @interface RunCreationRequest
697
+ */
698
+ interface RunCreationRequest {
699
+ /**
700
+ * Unique ID for the application to use for processing
701
+ * @type {string}
702
+ * @memberof RunCreationRequest
703
+ */
704
+ 'application_id': string;
705
+ /**
706
+ *
707
+ * @type {string}
708
+ * @memberof RunCreationRequest
709
+ */
710
+ 'version_number'?: string | null;
711
+ /**
712
+ *
713
+ * @type {object}
714
+ * @memberof RunCreationRequest
715
+ */
716
+ 'custom_metadata'?: object | null;
717
+ /**
718
+ * List of items (slides) to process. Each item represents a whole slide image (WSI) with its associated metadata and artifacts
719
+ * @type {Array<ItemCreationRequest>}
720
+ * @memberof RunCreationRequest
721
+ */
722
+ 'items': Array<ItemCreationRequest>;
723
+ }
724
+ /**
725
+ *
726
+ * @export
727
+ * @interface RunCreationResponse
728
+ */
729
+ interface RunCreationResponse {
730
+ /**
731
+ *
732
+ * @type {string}
733
+ * @memberof RunCreationResponse
734
+ */
735
+ 'run_id'?: string;
736
+ }
737
+ /**
738
+ *
739
+ * @export
740
+ * @interface RunItemStatistics
741
+ */
742
+ interface RunItemStatistics {
743
+ /**
744
+ * Total number of the items in the run
745
+ * @type {number}
746
+ * @memberof RunItemStatistics
747
+ */
748
+ 'item_count': number;
749
+ /**
750
+ * The number of items in `PENDING` state
751
+ * @type {number}
752
+ * @memberof RunItemStatistics
753
+ */
754
+ 'item_pending_count': number;
755
+ /**
756
+ * The number of items in `PROCESSING` state
757
+ * @type {number}
758
+ * @memberof RunItemStatistics
759
+ */
760
+ 'item_processing_count': number;
761
+ /**
762
+ * The number of items in `TERMINATED` state, and the item termination reason is `USER_ERROR`
763
+ * @type {number}
764
+ * @memberof RunItemStatistics
765
+ */
766
+ 'item_user_error_count': number;
767
+ /**
768
+ * The number of items in `TERMINATED` state, and the item termination reason is `SYSTEM_ERROR`
769
+ * @type {number}
770
+ * @memberof RunItemStatistics
771
+ */
772
+ 'item_system_error_count': number;
773
+ /**
774
+ * The number of items in `TERMINATED` state, and the item termination reason is `SKIPPED`
775
+ * @type {number}
776
+ * @memberof RunItemStatistics
777
+ */
778
+ 'item_skipped_count': number;
779
+ /**
780
+ * The number of items in `TERMINATED` state, and the item termination reason is `SUCCEEDED`
781
+ * @type {number}
782
+ * @memberof RunItemStatistics
783
+ */
784
+ 'item_succeeded_count': number;
785
+ }
786
+ /**
787
+ *
788
+ * @export
789
+ * @enum {string}
790
+ */
791
+ declare const RunOutput: {
792
+ readonly None: "NONE";
793
+ readonly Partial: "PARTIAL";
794
+ readonly Full: "FULL";
795
+ };
796
+ type RunOutput = typeof RunOutput[keyof typeof RunOutput];
797
+ /**
798
+ * Response schema for `Get run details` endpoint
799
+ * @export
800
+ * @interface RunReadResponse
801
+ */
802
+ interface RunReadResponse {
803
+ /**
804
+ * UUID of the application
805
+ * @type {string}
806
+ * @memberof RunReadResponse
807
+ */
808
+ 'run_id': string;
809
+ /**
810
+ * Application id
811
+ * @type {string}
812
+ * @memberof RunReadResponse
813
+ */
814
+ 'application_id': string;
815
+ /**
816
+ * Application version number
817
+ * @type {string}
818
+ * @memberof RunReadResponse
819
+ */
820
+ 'version_number': string;
821
+ /**
822
+ * 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.
823
+ * @type {RunState}
824
+ * @memberof RunReadResponse
825
+ */
826
+ 'state': RunState;
827
+ /**
828
+ * 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`.
829
+ * @type {RunOutput}
830
+ * @memberof RunReadResponse
831
+ */
832
+ 'output': RunOutput;
833
+ /**
834
+ *
835
+ * @type {RunTerminationReason}
836
+ * @memberof RunReadResponse
837
+ */
838
+ 'termination_reason': RunTerminationReason | null;
839
+ /**
840
+ *
841
+ * @type {string}
842
+ * @memberof RunReadResponse
843
+ */
844
+ 'error_code': string | null;
845
+ /**
846
+ *
847
+ * @type {string}
848
+ * @memberof RunReadResponse
849
+ */
850
+ 'error_message': string | null;
851
+ /**
852
+ * Aggregated statistics of the run execution
853
+ * @type {RunItemStatistics}
854
+ * @memberof RunReadResponse
855
+ */
856
+ 'statistics': RunItemStatistics;
857
+ /**
858
+ *
859
+ * @type {object}
860
+ * @memberof RunReadResponse
861
+ */
862
+ 'custom_metadata'?: object | null;
863
+ /**
864
+ *
865
+ * @type {string}
866
+ * @memberof RunReadResponse
867
+ */
868
+ 'custom_metadata_checksum'?: string | null;
869
+ /**
870
+ * Timestamp showing when the run was triggered
871
+ * @type {string}
872
+ * @memberof RunReadResponse
873
+ */
874
+ 'submitted_at': string;
875
+ /**
876
+ * Id of the user who triggered the run
877
+ * @type {string}
878
+ * @memberof RunReadResponse
879
+ */
880
+ 'submitted_by': string;
881
+ /**
882
+ *
883
+ * @type {string}
884
+ * @memberof RunReadResponse
885
+ */
886
+ 'terminated_at'?: string | null;
887
+ /**
888
+ *
889
+ * @type {number}
890
+ * @memberof RunReadResponse
891
+ */
892
+ 'num_preceding_items_org'?: number | null;
893
+ /**
894
+ *
895
+ * @type {number}
896
+ * @memberof RunReadResponse
897
+ */
898
+ 'num_preceding_items_platform'?: number | null;
899
+ }
900
+ /**
901
+ *
902
+ * @export
903
+ * @enum {string}
904
+ */
905
+ declare const RunState: {
906
+ readonly Pending: "PENDING";
907
+ readonly Processing: "PROCESSING";
908
+ readonly Terminated: "TERMINATED";
909
+ };
910
+ type RunState = typeof RunState[keyof typeof RunState];
911
+ /**
912
+ *
913
+ * @export
914
+ * @enum {string}
915
+ */
916
+ declare const RunTerminationReason: {
917
+ readonly AllItemsProcessed: "ALL_ITEMS_PROCESSED";
918
+ readonly CanceledBySystem: "CANCELED_BY_SYSTEM";
919
+ readonly CanceledByUser: "CANCELED_BY_USER";
920
+ };
921
+ type RunTerminationReason = typeof RunTerminationReason[keyof typeof RunTerminationReason];
922
+ /**
923
+ * 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
924
+ * @export
925
+ * @interface UserReadResponse
926
+ */
927
+ interface UserReadResponse {
928
+ /**
929
+ * Unique user identifier
930
+ * @type {string}
931
+ * @memberof UserReadResponse
932
+ */
933
+ 'id': string;
934
+ /**
935
+ *
936
+ * @type {string}
937
+ * @memberof UserReadResponse
938
+ */
939
+ 'email'?: string | null;
940
+ /**
941
+ *
942
+ * @type {boolean}
943
+ * @memberof UserReadResponse
944
+ */
945
+ 'email_verified'?: boolean | null;
946
+ /**
947
+ *
948
+ * @type {string}
949
+ * @memberof UserReadResponse
950
+ */
951
+ 'name'?: string | null;
952
+ /**
953
+ *
954
+ * @type {string}
955
+ * @memberof UserReadResponse
956
+ */
957
+ 'given_name'?: string | null;
958
+ /**
959
+ *
960
+ * @type {string}
961
+ * @memberof UserReadResponse
962
+ */
963
+ 'family_name'?: string | null;
964
+ /**
965
+ *
966
+ * @type {string}
967
+ * @memberof UserReadResponse
968
+ */
969
+ 'nickname'?: string | null;
970
+ /**
971
+ *
972
+ * @type {string}
973
+ * @memberof UserReadResponse
974
+ */
975
+ 'picture'?: string | null;
976
+ /**
977
+ *
978
+ * @type {string}
979
+ * @memberof UserReadResponse
980
+ */
981
+ 'updated_at'?: string | null;
982
+ }
983
+ /**
984
+ *
985
+ * @export
986
+ * @interface ValidationError
987
+ */
988
+ interface ValidationError {
989
+ /**
990
+ *
991
+ * @type {Array<ValidationErrorLocInner>}
992
+ * @memberof ValidationError
993
+ */
994
+ 'loc': Array<ValidationErrorLocInner>;
995
+ /**
996
+ *
997
+ * @type {string}
998
+ * @memberof ValidationError
999
+ */
1000
+ 'msg': string;
1001
+ /**
1002
+ *
1003
+ * @type {string}
1004
+ * @memberof ValidationError
1005
+ */
1006
+ 'type': string;
1007
+ }
1008
+ /**
1009
+ *
1010
+ * @export
1011
+ * @interface ValidationErrorLocInner
1012
+ */
1013
+ interface ValidationErrorLocInner {
1014
+ }
1015
+ /**
1016
+ * Base Response schema for the `Application Version Details` endpoint
1017
+ * @export
1018
+ * @interface VersionReadResponse
1019
+ */
1020
+ interface VersionReadResponse {
1021
+ /**
1022
+ * Semantic version of the application
1023
+ * @type {string}
1024
+ * @memberof VersionReadResponse
1025
+ */
1026
+ 'version_number': string;
1027
+ /**
1028
+ * Description of the changes relative to the previous version
1029
+ * @type {string}
1030
+ * @memberof VersionReadResponse
1031
+ */
1032
+ 'changelog': string;
1033
+ /**
1034
+ * List of the input fields, provided by the User
1035
+ * @type {Array<InputArtifact>}
1036
+ * @memberof VersionReadResponse
1037
+ */
1038
+ 'input_artifacts': Array<InputArtifact>;
1039
+ /**
1040
+ * List of the output fields, generated by the application
1041
+ * @type {Array<OutputArtifact>}
1042
+ * @memberof VersionReadResponse
1043
+ */
1044
+ 'output_artifacts': Array<OutputArtifact>;
1045
+ /**
1046
+ * The timestamp when the application version was registered
1047
+ * @type {string}
1048
+ * @memberof VersionReadResponse
1049
+ */
1050
+ 'released_at': string;
1051
+ }
1052
+ /**
1053
+ * PublicApi - axios parameter creator
1054
+ * @export
1055
+ */
1056
+ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
1057
+ /**
1058
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1059
+ * @summary Application Version Details
1060
+ * @param {string} applicationId
1061
+ * @param {string} version
1062
+ * @param {*} [options] Override http request option.
1063
+ * @throws {RequiredError}
1064
+ */
1065
+ applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet: (applicationId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1066
+ /**
1067
+ * 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.
1068
+ * @summary Cancel Run
1069
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1070
+ * @param {*} [options] Override http request option.
1071
+ * @throws {RequiredError}
1072
+ */
1073
+ cancelRunV1RunsRunIdCancelPost: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1074
+ /**
1075
+ * 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
1076
+ * @summary Initiate Run
1077
+ * @param {RunCreationRequest} runCreationRequest
1078
+ * @param {*} [options] Override http request option.
1079
+ * @throws {RequiredError}
1080
+ */
1081
+ createRunV1RunsPost: (runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1082
+ /**
1083
+ * 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.
1084
+ * @summary Delete Run Items
1085
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1086
+ * @param {*} [options] Override http request option.
1087
+ * @throws {RequiredError}
1088
+ */
1089
+ deleteRunItemsV1RunsRunIdArtifactsDelete: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1090
+ /**
1091
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
1092
+ * @summary Get Item By Run
1093
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
1094
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1095
+ * @param {*} [options] Override http request option.
1096
+ * @throws {RequiredError}
1097
+ */
1098
+ getItemByRunV1RunsRunIdItemsExternalIdGet: (runId: string, externalId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1099
+ /**
1100
+ * 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)
1101
+ * @summary Get current user
1102
+ * @param {*} [options] Override http request option.
1103
+ * @throws {RequiredError}
1104
+ */
1105
+ getMeV1MeGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1106
+ /**
1107
+ * 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.
1108
+ * @summary Get run details
1109
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1110
+ * @param {*} [options] Override http request option.
1111
+ * @throws {RequiredError}
1112
+ */
1113
+ getRunV1RunsRunIdGet: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1114
+ /**
1115
+ * 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.
1116
+ * @summary List available applications
1117
+ * @param {number} [page]
1118
+ * @param {number} [pageSize]
1119
+ * @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
1120
+ * @param {*} [options] Override http request option.
1121
+ * @throws {RequiredError}
1122
+ */
1123
+ listApplicationsV1ApplicationsGet: (page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1124
+ /**
1125
+ * 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
1126
+ * @summary List Run Items
1127
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1128
+ * @param {Array<string> | null} [itemIdIn] Filter for item ids
1129
+ * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
1130
+ * @param {ItemState | null} [state] Filter items by their state
1131
+ * @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
1132
+ * @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
1133
+ * @param {number} [page]
1134
+ * @param {number} [pageSize]
1135
+ * @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)
1136
+ * @param {*} [options] Override http request option.
1137
+ * @throws {RequiredError}
1138
+ */
1139
+ listRunItemsV1RunsRunIdItemsGet: (runId: string, 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>;
1140
+ /**
1141
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
1142
+ * @summary List Runs
1143
+ * @param {string | null} [applicationId] Optional application ID filter
1144
+ * @param {string | null} [applicationVersion] Optional Version Name
1145
+ * @param {string | null} [externalId] Optionally filter runs by items with this external ID
1146
+ * @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**
1147
+ * @param {number} [page]
1148
+ * @param {number} [pageSize]
1149
+ * @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)
1150
+ * @param {*} [options] Override http request option.
1151
+ * @throws {RequiredError}
1152
+ */
1153
+ listRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1154
+ /**
1155
+ * 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`.
1156
+ * @summary Put Item Custom Metadata By Run
1157
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
1158
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1159
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
1160
+ * @param {*} [options] Override http request option.
1161
+ * @throws {RequiredError}
1162
+ */
1163
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut: (runId: string, externalId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1164
+ /**
1165
+ * 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.
1166
+ * @summary Put Run Custom Metadata
1167
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1168
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
1169
+ * @param {*} [options] Override http request option.
1170
+ * @throws {RequiredError}
1171
+ */
1172
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut: (runId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1173
+ /**
1174
+ * Retrieve details of a specific application by its ID.
1175
+ * @summary Read Application By Id
1176
+ * @param {string} applicationId
1177
+ * @param {*} [options] Override http request option.
1178
+ * @throws {RequiredError}
1179
+ */
1180
+ readApplicationByIdV1ApplicationsApplicationIdGet: (applicationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1181
+ };
1182
+ /**
1183
+ * PublicApi - functional programming interface
1184
+ * @export
1185
+ */
1186
+ declare const PublicApiFp: (configuration?: Configuration) => {
1187
+ /**
1188
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1189
+ * @summary Application Version Details
1190
+ * @param {string} applicationId
1191
+ * @param {string} version
1192
+ * @param {*} [options] Override http request option.
1193
+ * @throws {RequiredError}
1194
+ */
1195
+ applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(applicationId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VersionReadResponse>>;
1196
+ /**
1197
+ * 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.
1198
+ * @summary Cancel Run
1199
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1200
+ * @param {*} [options] Override http request option.
1201
+ * @throws {RequiredError}
1202
+ */
1203
+ cancelRunV1RunsRunIdCancelPost(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1204
+ /**
1205
+ * 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
1206
+ * @summary Initiate Run
1207
+ * @param {RunCreationRequest} runCreationRequest
1208
+ * @param {*} [options] Override http request option.
1209
+ * @throws {RequiredError}
1210
+ */
1211
+ createRunV1RunsPost(runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunCreationResponse>>;
1212
+ /**
1213
+ * 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.
1214
+ * @summary Delete Run Items
1215
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1216
+ * @param {*} [options] Override http request option.
1217
+ * @throws {RequiredError}
1218
+ */
1219
+ deleteRunItemsV1RunsRunIdArtifactsDelete(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1220
+ /**
1221
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
1222
+ * @summary Get Item By Run
1223
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
1224
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1225
+ * @param {*} [options] Override http request option.
1226
+ * @throws {RequiredError}
1227
+ */
1228
+ getItemByRunV1RunsRunIdItemsExternalIdGet(runId: string, externalId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemResultReadResponse>>;
1229
+ /**
1230
+ * 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)
1231
+ * @summary Get current user
1232
+ * @param {*} [options] Override http request option.
1233
+ * @throws {RequiredError}
1234
+ */
1235
+ getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeReadResponse>>;
1236
+ /**
1237
+ * 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.
1238
+ * @summary Get run details
1239
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1240
+ * @param {*} [options] Override http request option.
1241
+ * @throws {RequiredError}
1242
+ */
1243
+ getRunV1RunsRunIdGet(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunReadResponse>>;
1244
+ /**
1245
+ * 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.
1246
+ * @summary List available applications
1247
+ * @param {number} [page]
1248
+ * @param {number} [pageSize]
1249
+ * @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
1250
+ * @param {*} [options] Override http request option.
1251
+ * @throws {RequiredError}
1252
+ */
1253
+ listApplicationsV1ApplicationsGet(page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicationReadShortResponse>>>;
1254
+ /**
1255
+ * 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
1256
+ * @summary List Run Items
1257
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1258
+ * @param {Array<string> | null} [itemIdIn] Filter for item ids
1259
+ * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
1260
+ * @param {ItemState | null} [state] Filter items by their state
1261
+ * @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
1262
+ * @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
1263
+ * @param {number} [page]
1264
+ * @param {number} [pageSize]
1265
+ * @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)
1266
+ * @param {*} [options] Override http request option.
1267
+ * @throws {RequiredError}
1268
+ */
1269
+ listRunItemsV1RunsRunIdItemsGet(runId: string, 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>>>;
1270
+ /**
1271
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
1272
+ * @summary List Runs
1273
+ * @param {string | null} [applicationId] Optional application ID filter
1274
+ * @param {string | null} [applicationVersion] Optional Version Name
1275
+ * @param {string | null} [externalId] Optionally filter runs by items with this external ID
1276
+ * @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**
1277
+ * @param {number} [page]
1278
+ * @param {number} [pageSize]
1279
+ * @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)
1280
+ * @param {*} [options] Override http request option.
1281
+ * @throws {RequiredError}
1282
+ */
1283
+ listRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
1284
+ /**
1285
+ * 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`.
1286
+ * @summary Put Item Custom Metadata By Run
1287
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
1288
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1289
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
1290
+ * @param {*} [options] Override http request option.
1291
+ * @throws {RequiredError}
1292
+ */
1293
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(runId: string, externalId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomMetadataUpdateResponse>>;
1294
+ /**
1295
+ * 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.
1296
+ * @summary Put Run Custom Metadata
1297
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
1298
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
1299
+ * @param {*} [options] Override http request option.
1300
+ * @throws {RequiredError}
1301
+ */
1302
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(runId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomMetadataUpdateResponse>>;
1303
+ /**
1304
+ * Retrieve details of a specific application by its ID.
1305
+ * @summary Read Application By Id
1306
+ * @param {string} applicationId
1307
+ * @param {*} [options] Override http request option.
1308
+ * @throws {RequiredError}
1309
+ */
1310
+ readApplicationByIdV1ApplicationsApplicationIdGet(applicationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationReadResponse>>;
1311
+ };
1312
+ /**
1313
+ * PublicApi - factory interface
1314
+ * @export
1315
+ */
1316
+ declare const PublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1317
+ /**
1318
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1319
+ * @summary Application Version Details
1320
+ * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
1321
+ * @param {*} [options] Override http request option.
1322
+ * @throws {RequiredError}
1323
+ */
1324
+ applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionReadResponse>;
1325
+ /**
1326
+ * 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.
1327
+ * @summary Cancel Run
1328
+ * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
1329
+ * @param {*} [options] Override http request option.
1330
+ * @throws {RequiredError}
1331
+ */
1332
+ cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1333
+ /**
1334
+ * 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
1335
+ * @summary Initiate Run
1336
+ * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
1337
+ * @param {*} [options] Override http request option.
1338
+ * @throws {RequiredError}
1339
+ */
1340
+ createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
1341
+ /**
1342
+ * 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.
1343
+ * @summary Delete Run Items
1344
+ * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
1345
+ * @param {*} [options] Override http request option.
1346
+ * @throws {RequiredError}
1347
+ */
1348
+ deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1349
+ /**
1350
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
1351
+ * @summary Get Item By Run
1352
+ * @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
1353
+ * @param {*} [options] Override http request option.
1354
+ * @throws {RequiredError}
1355
+ */
1356
+ getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters: PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemResultReadResponse>;
1357
+ /**
1358
+ * 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)
1359
+ * @summary Get current user
1360
+ * @param {*} [options] Override http request option.
1361
+ * @throws {RequiredError}
1362
+ */
1363
+ getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
1364
+ /**
1365
+ * 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.
1366
+ * @summary Get run details
1367
+ * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
1368
+ * @param {*} [options] Override http request option.
1369
+ * @throws {RequiredError}
1370
+ */
1371
+ getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
1372
+ /**
1373
+ * 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.
1374
+ * @summary List available applications
1375
+ * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
1376
+ * @param {*} [options] Override http request option.
1377
+ * @throws {RequiredError}
1378
+ */
1379
+ listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
1380
+ /**
1381
+ * 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
1382
+ * @summary List Run Items
1383
+ * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
1384
+ * @param {*} [options] Override http request option.
1385
+ * @throws {RequiredError}
1386
+ */
1387
+ listRunItemsV1RunsRunIdItemsGet(requestParameters: PublicApiListRunItemsV1RunsRunIdItemsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ItemResultReadResponse>>;
1388
+ /**
1389
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
1390
+ * @summary List Runs
1391
+ * @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
1392
+ * @param {*} [options] Override http request option.
1393
+ * @throws {RequiredError}
1394
+ */
1395
+ listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
1396
+ /**
1397
+ * 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`.
1398
+ * @summary Put Item Custom Metadata By Run
1399
+ * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
1400
+ * @param {*} [options] Override http request option.
1401
+ * @throws {RequiredError}
1402
+ */
1403
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
1404
+ /**
1405
+ * 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.
1406
+ * @summary Put Run Custom Metadata
1407
+ * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
1408
+ * @param {*} [options] Override http request option.
1409
+ * @throws {RequiredError}
1410
+ */
1411
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
1412
+ /**
1413
+ * Retrieve details of a specific application by its ID.
1414
+ * @summary Read Application By Id
1415
+ * @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
1416
+ * @param {*} [options] Override http request option.
1417
+ * @throws {RequiredError}
1418
+ */
1419
+ readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationReadResponse>;
1420
+ };
1421
+ /**
1422
+ * PublicApi - interface
1423
+ * @export
1424
+ * @interface PublicApi
1425
+ */
1426
+ interface PublicApiInterface {
1427
+ /**
1428
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1429
+ * @summary Application Version Details
1430
+ * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
1431
+ * @param {*} [options] Override http request option.
1432
+ * @throws {RequiredError}
1433
+ * @memberof PublicApiInterface
1434
+ */
1435
+ applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionReadResponse>;
1436
+ /**
1437
+ * 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.
1438
+ * @summary Cancel Run
1439
+ * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
1440
+ * @param {*} [options] Override http request option.
1441
+ * @throws {RequiredError}
1442
+ * @memberof PublicApiInterface
1443
+ */
1444
+ cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1445
+ /**
1446
+ * 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
1447
+ * @summary Initiate Run
1448
+ * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
1449
+ * @param {*} [options] Override http request option.
1450
+ * @throws {RequiredError}
1451
+ * @memberof PublicApiInterface
1452
+ */
1453
+ createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
1454
+ /**
1455
+ * 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.
1456
+ * @summary Delete Run Items
1457
+ * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
1458
+ * @param {*} [options] Override http request option.
1459
+ * @throws {RequiredError}
1460
+ * @memberof PublicApiInterface
1461
+ */
1462
+ deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
1463
+ /**
1464
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
1465
+ * @summary Get Item By Run
1466
+ * @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
1467
+ * @param {*} [options] Override http request option.
1468
+ * @throws {RequiredError}
1469
+ * @memberof PublicApiInterface
1470
+ */
1471
+ getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters: PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemResultReadResponse>;
1472
+ /**
1473
+ * 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)
1474
+ * @summary Get current user
1475
+ * @param {*} [options] Override http request option.
1476
+ * @throws {RequiredError}
1477
+ * @memberof PublicApiInterface
1478
+ */
1479
+ getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
1480
+ /**
1481
+ * 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.
1482
+ * @summary Get run details
1483
+ * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
1484
+ * @param {*} [options] Override http request option.
1485
+ * @throws {RequiredError}
1486
+ * @memberof PublicApiInterface
1487
+ */
1488
+ getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
1489
+ /**
1490
+ * 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.
1491
+ * @summary List available applications
1492
+ * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
1493
+ * @param {*} [options] Override http request option.
1494
+ * @throws {RequiredError}
1495
+ * @memberof PublicApiInterface
1496
+ */
1497
+ listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
1498
+ /**
1499
+ * 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
1500
+ * @summary List Run Items
1501
+ * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
1502
+ * @param {*} [options] Override http request option.
1503
+ * @throws {RequiredError}
1504
+ * @memberof PublicApiInterface
1505
+ */
1506
+ listRunItemsV1RunsRunIdItemsGet(requestParameters: PublicApiListRunItemsV1RunsRunIdItemsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ItemResultReadResponse>>;
1507
+ /**
1508
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
1509
+ * @summary List Runs
1510
+ * @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
1511
+ * @param {*} [options] Override http request option.
1512
+ * @throws {RequiredError}
1513
+ * @memberof PublicApiInterface
1514
+ */
1515
+ listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
1516
+ /**
1517
+ * 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`.
1518
+ * @summary Put Item Custom Metadata By Run
1519
+ * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
1520
+ * @param {*} [options] Override http request option.
1521
+ * @throws {RequiredError}
1522
+ * @memberof PublicApiInterface
1523
+ */
1524
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
1525
+ /**
1526
+ * 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.
1527
+ * @summary Put Run Custom Metadata
1528
+ * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
1529
+ * @param {*} [options] Override http request option.
1530
+ * @throws {RequiredError}
1531
+ * @memberof PublicApiInterface
1532
+ */
1533
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomMetadataUpdateResponse>;
1534
+ /**
1535
+ * Retrieve details of a specific application by its ID.
1536
+ * @summary Read Application By Id
1537
+ * @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
1538
+ * @param {*} [options] Override http request option.
1539
+ * @throws {RequiredError}
1540
+ * @memberof PublicApiInterface
1541
+ */
1542
+ readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationReadResponse>;
1543
+ }
1544
+ /**
1545
+ * Request parameters for applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet operation in PublicApi.
1546
+ * @export
1547
+ * @interface PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest
1548
+ */
1549
+ interface PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest {
1550
+ /**
1551
+ *
1552
+ * @type {string}
1553
+ * @memberof PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet
1554
+ */
1555
+ readonly applicationId: string;
1556
+ /**
1557
+ *
1558
+ * @type {string}
1559
+ * @memberof PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet
1560
+ */
1561
+ readonly version: string;
1562
+ }
1563
+ /**
1564
+ * Request parameters for cancelRunV1RunsRunIdCancelPost operation in PublicApi.
1565
+ * @export
1566
+ * @interface PublicApiCancelRunV1RunsRunIdCancelPostRequest
1567
+ */
1568
+ interface PublicApiCancelRunV1RunsRunIdCancelPostRequest {
1569
+ /**
1570
+ * Run id, returned by &#x60;POST /runs/&#x60; endpoint
1571
+ * @type {string}
1572
+ * @memberof PublicApiCancelRunV1RunsRunIdCancelPost
1573
+ */
1574
+ readonly runId: string;
1575
+ }
1576
+ /**
1577
+ * Request parameters for createRunV1RunsPost operation in PublicApi.
1578
+ * @export
1579
+ * @interface PublicApiCreateRunV1RunsPostRequest
1580
+ */
1581
+ interface PublicApiCreateRunV1RunsPostRequest {
1582
+ /**
1583
+ *
1584
+ * @type {RunCreationRequest}
1585
+ * @memberof PublicApiCreateRunV1RunsPost
1586
+ */
1587
+ readonly runCreationRequest: RunCreationRequest;
1588
+ }
1589
+ /**
1590
+ * Request parameters for deleteRunItemsV1RunsRunIdArtifactsDelete operation in PublicApi.
1591
+ * @export
1592
+ * @interface PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest
1593
+ */
1594
+ interface PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest {
1595
+ /**
1596
+ * Run id, returned by &#x60;POST /runs/&#x60; endpoint
1597
+ * @type {string}
1598
+ * @memberof PublicApiDeleteRunItemsV1RunsRunIdArtifactsDelete
1599
+ */
1600
+ readonly runId: string;
1601
+ }
1602
+ /**
1603
+ * Request parameters for getItemByRunV1RunsRunIdItemsExternalIdGet operation in PublicApi.
1604
+ * @export
1605
+ * @interface PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest
1606
+ */
1607
+ interface PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest {
1608
+ /**
1609
+ * The run id, returned by &#x60;POST /runs/&#x60; endpoint
1610
+ * @type {string}
1611
+ * @memberof PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGet
1612
+ */
1613
+ readonly runId: string;
1614
+ /**
1615
+ * The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1616
+ * @type {string}
1617
+ * @memberof PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGet
1618
+ */
1619
+ readonly externalId: string;
1620
+ }
1621
+ /**
1622
+ * Request parameters for getRunV1RunsRunIdGet operation in PublicApi.
1623
+ * @export
1624
+ * @interface PublicApiGetRunV1RunsRunIdGetRequest
1625
+ */
1626
+ interface PublicApiGetRunV1RunsRunIdGetRequest {
1627
+ /**
1628
+ * Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1629
+ * @type {string}
1630
+ * @memberof PublicApiGetRunV1RunsRunIdGet
1631
+ */
1632
+ readonly runId: string;
1633
+ }
1634
+ /**
1635
+ * Request parameters for listApplicationsV1ApplicationsGet operation in PublicApi.
1636
+ * @export
1637
+ * @interface PublicApiListApplicationsV1ApplicationsGetRequest
1638
+ */
1639
+ interface PublicApiListApplicationsV1ApplicationsGetRequest {
1640
+ /**
1641
+ *
1642
+ * @type {number}
1643
+ * @memberof PublicApiListApplicationsV1ApplicationsGet
1644
+ */
1645
+ readonly page?: number;
1646
+ /**
1647
+ *
1648
+ * @type {number}
1649
+ * @memberof PublicApiListApplicationsV1ApplicationsGet
1650
+ */
1651
+ readonly pageSize?: number;
1652
+ /**
1653
+ * 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
1654
+ * @type {Array<string>}
1655
+ * @memberof PublicApiListApplicationsV1ApplicationsGet
1656
+ */
1657
+ readonly sort?: Array<string> | null;
1658
+ }
1659
+ /**
1660
+ * Request parameters for listRunItemsV1RunsRunIdItemsGet operation in PublicApi.
1661
+ * @export
1662
+ * @interface PublicApiListRunItemsV1RunsRunIdItemsGetRequest
1663
+ */
1664
+ interface PublicApiListRunItemsV1RunsRunIdItemsGetRequest {
1665
+ /**
1666
+ * Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1667
+ * @type {string}
1668
+ * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
1669
+ */
1670
+ readonly runId: string;
1671
+ /**
1672
+ * Filter for item ids
1673
+ * @type {Array<string>}
1674
+ * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
1675
+ */
1676
+ readonly itemIdIn?: Array<string> | null;
1677
+ /**
1678
+ * Filter for items by their external_id from the input payload
1679
+ * @type {Array<string>}
1680
+ * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
1681
+ */
1682
+ readonly externalIdIn?: Array<string> | null;
1683
+ /**
1684
+ * Filter items by their state
1685
+ * @type {ItemState}
1686
+ * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
1687
+ */
1688
+ readonly state?: ItemState | null;
1689
+ /**
1690
+ * Filter items by their termination reason. Only applies to TERMINATED items.
1691
+ * @type {ItemTerminationReason}
1692
+ * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
1693
+ */
1694
+ readonly terminationReason?: ItemTerminationReason | null;
1695
+ /**
1696
+ * JSONPath expression to filter items by their custom_metadata
1697
+ * @type {string}
1698
+ * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
1699
+ */
1700
+ readonly customMetadata?: string | null;
1701
+ /**
1702
+ *
1703
+ * @type {number}
1704
+ * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
1705
+ */
1706
+ readonly page?: number;
1707
+ /**
1708
+ *
1709
+ * @type {number}
1710
+ * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
1711
+ */
1712
+ readonly pageSize?: number;
1713
+ /**
1714
+ * 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)
1715
+ * @type {Array<string>}
1716
+ * @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
1717
+ */
1718
+ readonly sort?: Array<string> | null;
1719
+ }
1720
+ /**
1721
+ * Request parameters for listRunsV1RunsGet operation in PublicApi.
1722
+ * @export
1723
+ * @interface PublicApiListRunsV1RunsGetRequest
1724
+ */
1725
+ interface PublicApiListRunsV1RunsGetRequest {
1726
+ /**
1727
+ * Optional application ID filter
1728
+ * @type {string}
1729
+ * @memberof PublicApiListRunsV1RunsGet
1730
+ */
1731
+ readonly applicationId?: string | null;
1732
+ /**
1733
+ * Optional Version Name
1734
+ * @type {string}
1735
+ * @memberof PublicApiListRunsV1RunsGet
1736
+ */
1737
+ readonly applicationVersion?: string | null;
1738
+ /**
1739
+ * Optionally filter runs by items with this external ID
1740
+ * @type {string}
1741
+ * @memberof PublicApiListRunsV1RunsGet
1742
+ */
1743
+ readonly externalId?: string | null;
1744
+ /**
1745
+ * 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**
1746
+ * @type {string}
1747
+ * @memberof PublicApiListRunsV1RunsGet
1748
+ */
1749
+ readonly customMetadata?: string | null;
1750
+ /**
1751
+ *
1752
+ * @type {number}
1753
+ * @memberof PublicApiListRunsV1RunsGet
1754
+ */
1755
+ readonly page?: number;
1756
+ /**
1757
+ *
1758
+ * @type {number}
1759
+ * @memberof PublicApiListRunsV1RunsGet
1760
+ */
1761
+ readonly pageSize?: number;
1762
+ /**
1763
+ * 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)
1764
+ * @type {Array<string>}
1765
+ * @memberof PublicApiListRunsV1RunsGet
1766
+ */
1767
+ readonly sort?: Array<string> | null;
1768
+ }
1769
+ /**
1770
+ * Request parameters for putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut operation in PublicApi.
1771
+ * @export
1772
+ * @interface PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest
1773
+ */
1774
+ interface PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest {
1775
+ /**
1776
+ * The run id, returned by &#x60;POST /runs/&#x60; endpoint
1777
+ * @type {string}
1778
+ * @memberof PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut
1779
+ */
1780
+ readonly runId: string;
1781
+ /**
1782
+ * The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1783
+ * @type {string}
1784
+ * @memberof PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut
1785
+ */
1786
+ readonly externalId: string;
1787
+ /**
1788
+ *
1789
+ * @type {CustomMetadataUpdateRequest}
1790
+ * @memberof PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut
1791
+ */
1792
+ readonly customMetadataUpdateRequest: CustomMetadataUpdateRequest;
1793
+ }
1794
+ /**
1795
+ * Request parameters for putRunCustomMetadataV1RunsRunIdCustomMetadataPut operation in PublicApi.
1796
+ * @export
1797
+ * @interface PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest
1798
+ */
1799
+ interface PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest {
1800
+ /**
1801
+ * Run id, returned by &#x60;POST /runs/&#x60; endpoint
1802
+ * @type {string}
1803
+ * @memberof PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPut
1804
+ */
1805
+ readonly runId: string;
1806
+ /**
1807
+ *
1808
+ * @type {CustomMetadataUpdateRequest}
1809
+ * @memberof PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPut
1810
+ */
1811
+ readonly customMetadataUpdateRequest: CustomMetadataUpdateRequest;
1812
+ }
1813
+ /**
1814
+ * Request parameters for readApplicationByIdV1ApplicationsApplicationIdGet operation in PublicApi.
1815
+ * @export
1816
+ * @interface PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest
1817
+ */
1818
+ interface PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest {
1819
+ /**
1820
+ *
1821
+ * @type {string}
1822
+ * @memberof PublicApiReadApplicationByIdV1ApplicationsApplicationIdGet
1823
+ */
1824
+ readonly applicationId: string;
1825
+ }
1826
+ /**
1827
+ * PublicApi - object-oriented interface
1828
+ * @export
1829
+ * @class PublicApi
1830
+ * @extends {BaseAPI}
1831
+ */
1832
+ declare class PublicApi extends BaseAPI implements PublicApiInterface {
1833
+ /**
1834
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
1835
+ * @summary Application Version Details
1836
+ * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
1837
+ * @param {*} [options] Override http request option.
1838
+ * @throws {RequiredError}
1839
+ * @memberof PublicApi
1840
+ */
1841
+ applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters: PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionReadResponse, any, {}>>;
1842
+ /**
1843
+ * 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.
1844
+ * @summary Cancel Run
1845
+ * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
1846
+ * @param {*} [options] Override http request option.
1847
+ * @throws {RequiredError}
1848
+ * @memberof PublicApi
1849
+ */
1850
+ cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
1851
+ /**
1852
+ * 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
1853
+ * @summary Initiate Run
1854
+ * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
1855
+ * @param {*} [options] Override http request option.
1856
+ * @throws {RequiredError}
1857
+ * @memberof PublicApi
1858
+ */
1859
+ createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunCreationResponse, any, {}>>;
1860
+ /**
1861
+ * 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.
1862
+ * @summary Delete Run Items
1863
+ * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
1864
+ * @param {*} [options] Override http request option.
1865
+ * @throws {RequiredError}
1866
+ * @memberof PublicApi
1867
+ */
1868
+ deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters: PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
1869
+ /**
1870
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
1871
+ * @summary Get Item By Run
1872
+ * @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
1873
+ * @param {*} [options] Override http request option.
1874
+ * @throws {RequiredError}
1875
+ * @memberof PublicApi
1876
+ */
1877
+ getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters: PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ItemResultReadResponse, any, {}>>;
1878
+ /**
1879
+ * 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)
1880
+ * @summary Get current user
1881
+ * @param {*} [options] Override http request option.
1882
+ * @throws {RequiredError}
1883
+ * @memberof PublicApi
1884
+ */
1885
+ getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<MeReadResponse, any, {}>>;
1886
+ /**
1887
+ * 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.
1888
+ * @summary Get run details
1889
+ * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
1890
+ * @param {*} [options] Override http request option.
1891
+ * @throws {RequiredError}
1892
+ * @memberof PublicApi
1893
+ */
1894
+ getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse, any, {}>>;
1895
+ /**
1896
+ * 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.
1897
+ * @summary List available applications
1898
+ * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
1899
+ * @param {*} [options] Override http request option.
1900
+ * @throws {RequiredError}
1901
+ * @memberof PublicApi
1902
+ */
1903
+ listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadShortResponse[], any, {}>>;
1904
+ /**
1905
+ * 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
1906
+ * @summary List Run Items
1907
+ * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
1908
+ * @param {*} [options] Override http request option.
1909
+ * @throws {RequiredError}
1910
+ * @memberof PublicApi
1911
+ */
1912
+ listRunItemsV1RunsRunIdItemsGet(requestParameters: PublicApiListRunItemsV1RunsRunIdItemsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ItemResultReadResponse[], any, {}>>;
1913
+ /**
1914
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
1915
+ * @summary List Runs
1916
+ * @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
1917
+ * @param {*} [options] Override http request option.
1918
+ * @throws {RequiredError}
1919
+ * @memberof PublicApi
1920
+ */
1921
+ listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse[], any, {}>>;
1922
+ /**
1923
+ * 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`.
1924
+ * @summary Put Item Custom Metadata By Run
1925
+ * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
1926
+ * @param {*} [options] Override http request option.
1927
+ * @throws {RequiredError}
1928
+ * @memberof PublicApi
1929
+ */
1930
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters: PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CustomMetadataUpdateResponse, any, {}>>;
1931
+ /**
1932
+ * 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.
1933
+ * @summary Put Run Custom Metadata
1934
+ * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
1935
+ * @param {*} [options] Override http request option.
1936
+ * @throws {RequiredError}
1937
+ * @memberof PublicApi
1938
+ */
1939
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters: PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CustomMetadataUpdateResponse, any, {}>>;
1940
+ /**
1941
+ * Retrieve details of a specific application by its ID.
1942
+ * @summary Read Application By Id
1943
+ * @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
1944
+ * @param {*} [options] Override http request option.
1945
+ * @throws {RequiredError}
1946
+ * @memberof PublicApi
1947
+ */
1948
+ readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadResponse, any, {}>>;
1949
+ }
1950
+
1951
+ export { type ApplicationReadShortResponse as A, type PublicApiInterface as B, type CustomMetadataUpdateRequest as C, type PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest as D, type PublicApiCancelRunV1RunsRunIdCancelPostRequest as E, type PublicApiCreateRunV1RunsPostRequest as F, type PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest as G, type HTTPValidationError as H, type ItemResultReadResponse as I, type PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest as J, type PublicApiGetRunV1RunsRunIdGetRequest as K, type PublicApiListApplicationsV1ApplicationsGetRequest as L, type MeReadResponse as M, type PublicApiListRunItemsV1RunsRunIdItemsGetRequest as N, type OrganizationReadResponse as O, PublicApiAxiosParamCreator as P, type PublicApiListRunsV1RunsGetRequest as Q, type RunReadResponse as R, type PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest as S, type PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest as T, type UserReadResponse as U, type VersionReadResponse as V, type PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest as W, PublicApi as X, type ConfigurationParameters as Y, Configuration as Z, type ApplicationReadResponse as a, type RunCreationRequest as b, type RunCreationResponse as c, type ApplicationVersion as d, ArtifactOutput as e, ArtifactState as f, ArtifactTerminationReason as g, type CustomMetadataUpdateResponse as h, type InputArtifact as i, type InputArtifactCreationRequest as j, type ItemCreationRequest as k, ItemOutput as l, ItemState as m, ItemTerminationReason as n, type OutputArtifact as o, type OutputArtifactResultReadResponse as p, OutputArtifactScope as q, OutputArtifactVisibility as r, type RunItemStatistics as s, RunOutput as t, RunState as u, RunTerminationReason as v, type ValidationError as w, type ValidationErrorLocInner as x, PublicApiFp as y, PublicApiFactory as z };