@aignostics/sdk 3.4.0 → 3.5.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.
package/dist/index.cjs CHANGED
@@ -103,6 +103,11 @@ var ArtifactTerminationReason = {
103
103
  SystemError: "SYSTEM_ERROR",
104
104
  Skipped: "SKIPPED"
105
105
  };
106
+ var GrantRelation = {
107
+ Owner: "owner",
108
+ Editor: "editor",
109
+ Viewer: "viewer"
110
+ };
106
111
  var ItemOutput = {
107
112
  None: "NONE",
108
113
  Full: "FULL"
@@ -126,6 +131,12 @@ var OutputArtifactVisibility = {
126
131
  Internal: "INTERNAL",
127
132
  External: "EXTERNAL"
128
133
  };
134
+ var ResourceType = {
135
+ Run: "run",
136
+ Item: "item",
137
+ OutputArtifact: "output_artifact",
138
+ ShareToken: "share_token"
139
+ };
129
140
  var RunOutput = {
130
141
  None: "NONE",
131
142
  Partial: "PARTIAL",
@@ -141,6 +152,12 @@ var RunTerminationReason = {
141
152
  CanceledBySystem: "CANCELED_BY_SYSTEM",
142
153
  CanceledByUser: "CANCELED_BY_USER"
143
154
  };
155
+ var SubjectType = {
156
+ User: "user",
157
+ OrganizationAdmin: "organization_admin",
158
+ OrganizationUser: "organization_user",
159
+ ShareToken: "share_token"
160
+ };
144
161
  var VersionDocumentVisibility = {
145
162
  Public: "public",
146
163
  Internal: "internal"
@@ -203,6 +220,35 @@ var PublicApiAxiosParamCreator = function(configuration) {
203
220
  options: localVarRequestOptions
204
221
  };
205
222
  },
223
+ /**
224
+ * Create a grant to share access to a resource with a subject (user or organization).
225
+ * @summary Create Grant
226
+ * @param {GrantCreateRequest} grantCreateRequest
227
+ * @param {*} [options] Override http request option.
228
+ * @throws {RequiredError}
229
+ */
230
+ createGrantV1AccessGrantsPost: async (grantCreateRequest, options = {}) => {
231
+ assertParamExists("createGrantV1AccessGrantsPost", "grantCreateRequest", grantCreateRequest);
232
+ const localVarPath = `/v1/access/grants`;
233
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
234
+ let baseOptions;
235
+ if (configuration) {
236
+ baseOptions = configuration.baseOptions;
237
+ }
238
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
239
+ const localVarHeaderParameter = {};
240
+ const localVarQueryParameter = {};
241
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
242
+ localVarHeaderParameter["Content-Type"] = "application/json";
243
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
244
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
245
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
246
+ localVarRequestOptions.data = serializeDataIfNeeded(grantCreateRequest, localVarRequestOptions, configuration);
247
+ return {
248
+ url: toPathString(localVarUrlObj),
249
+ options: localVarRequestOptions
250
+ };
251
+ },
206
252
  /**
207
253
  * 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
208
254
  * @summary Initiate Run
@@ -232,6 +278,35 @@ var PublicApiAxiosParamCreator = function(configuration) {
232
278
  options: localVarRequestOptions
233
279
  };
234
280
  },
281
+ /**
282
+ * Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
283
+ * @summary Create Share Token
284
+ * @param {ShareTokenCreateRequest} shareTokenCreateRequest
285
+ * @param {*} [options] Override http request option.
286
+ * @throws {RequiredError}
287
+ */
288
+ createShareTokenV1AccessShareTokensPost: async (shareTokenCreateRequest, options = {}) => {
289
+ assertParamExists("createShareTokenV1AccessShareTokensPost", "shareTokenCreateRequest", shareTokenCreateRequest);
290
+ const localVarPath = `/v1/access/share-tokens`;
291
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
292
+ let baseOptions;
293
+ if (configuration) {
294
+ baseOptions = configuration.baseOptions;
295
+ }
296
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
297
+ const localVarHeaderParameter = {};
298
+ const localVarQueryParameter = {};
299
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
300
+ localVarHeaderParameter["Content-Type"] = "application/json";
301
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
302
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
303
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
304
+ localVarRequestOptions.data = serializeDataIfNeeded(shareTokenCreateRequest, localVarRequestOptions, configuration);
305
+ return {
306
+ url: toPathString(localVarUrlObj),
307
+ options: localVarRequestOptions
308
+ };
309
+ },
235
310
  /**
236
311
  * 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.
237
312
  * @summary Delete Run Items
@@ -264,10 +339,11 @@ var PublicApiAxiosParamCreator = function(configuration) {
264
339
  * @summary Get Artifact Url
265
340
  * @param {string} runId Run id, returned by `POST /runs/` endpoint
266
341
  * @param {string} artifactId The artifact id to download
342
+ * @param {string | null} [shareToken] Share token for accessing shared runs
267
343
  * @param {*} [options] Override http request option.
268
344
  * @throws {RequiredError}
269
345
  */
270
- getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: async (runId, artifactId, options = {}) => {
346
+ getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: async (runId, artifactId, shareToken, options = {}) => {
271
347
  assertParamExists("getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet", "runId", runId);
272
348
  assertParamExists("getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet", "artifactId", artifactId);
273
349
  const localVarPath = `/v1/runs/{run_id}/artifacts/{artifact_id}/file`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"artifact_id"}}`, encodeURIComponent(String(artifactId)));
@@ -280,6 +356,36 @@ var PublicApiAxiosParamCreator = function(configuration) {
280
356
  const localVarHeaderParameter = {};
281
357
  const localVarQueryParameter = {};
282
358
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
359
+ if (shareToken !== void 0) {
360
+ localVarQueryParameter["share_token"] = shareToken;
361
+ }
362
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
363
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
364
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
365
+ return {
366
+ url: toPathString(localVarUrlObj),
367
+ options: localVarRequestOptions
368
+ };
369
+ },
370
+ /**
371
+ * Get a grant by its ID.
372
+ * @summary Get Grant
373
+ * @param {string} grantId Grant ID
374
+ * @param {*} [options] Override http request option.
375
+ * @throws {RequiredError}
376
+ */
377
+ getGrantV1AccessGrantsGrantIdGet: async (grantId, options = {}) => {
378
+ assertParamExists("getGrantV1AccessGrantsGrantIdGet", "grantId", grantId);
379
+ const localVarPath = `/v1/access/grants/{grant_id}`.replace(`{${"grant_id"}}`, encodeURIComponent(String(grantId)));
380
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
381
+ let baseOptions;
382
+ if (configuration) {
383
+ baseOptions = configuration.baseOptions;
384
+ }
385
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
386
+ const localVarHeaderParameter = {};
387
+ const localVarQueryParameter = {};
388
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
283
389
  setSearchParams(localVarUrlObj, localVarQueryParameter);
284
390
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
285
391
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -293,10 +399,11 @@ var PublicApiAxiosParamCreator = function(configuration) {
293
399
  * @summary Get Item By Run
294
400
  * @param {string} runId The run id, returned by `POST /runs/` endpoint
295
401
  * @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
402
+ * @param {string | null} [shareToken] Share token for accessing shared runs
296
403
  * @param {*} [options] Override http request option.
297
404
  * @throws {RequiredError}
298
405
  */
299
- getItemByRunV1RunsRunIdItemsExternalIdGet: async (runId, externalId, options = {}) => {
406
+ getItemByRunV1RunsRunIdItemsExternalIdGet: async (runId, externalId, shareToken, options = {}) => {
300
407
  assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "runId", runId);
301
408
  assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "externalId", externalId);
302
409
  const localVarPath = `/v1/runs/{run_id}/items/{external_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"external_id"}}`, encodeURIComponent(String(externalId)));
@@ -309,6 +416,9 @@ var PublicApiAxiosParamCreator = function(configuration) {
309
416
  const localVarHeaderParameter = {};
310
417
  const localVarQueryParameter = {};
311
418
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
419
+ if (shareToken !== void 0) {
420
+ localVarQueryParameter["share_token"] = shareToken;
421
+ }
312
422
  setSearchParams(localVarUrlObj, localVarQueryParameter);
313
423
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
314
424
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -343,13 +453,14 @@ var PublicApiAxiosParamCreator = function(configuration) {
343
453
  };
344
454
  },
345
455
  /**
346
- * 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.
456
+ * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
347
457
  * @summary Get run details
348
458
  * @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
459
+ * @param {string | null} [shareToken] Share token for accessing shared runs
349
460
  * @param {*} [options] Override http request option.
350
461
  * @throws {RequiredError}
351
462
  */
352
- getRunV1RunsRunIdGet: async (runId, options = {}) => {
463
+ getRunV1RunsRunIdGet: async (runId, shareToken, options = {}) => {
353
464
  assertParamExists("getRunV1RunsRunIdGet", "runId", runId);
354
465
  const localVarPath = `/v1/runs/{run_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
355
466
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -361,6 +472,36 @@ var PublicApiAxiosParamCreator = function(configuration) {
361
472
  const localVarHeaderParameter = {};
362
473
  const localVarQueryParameter = {};
363
474
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
475
+ if (shareToken !== void 0) {
476
+ localVarQueryParameter["share_token"] = shareToken;
477
+ }
478
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
479
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
480
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
481
+ return {
482
+ url: toPathString(localVarUrlObj),
483
+ options: localVarRequestOptions
484
+ };
485
+ },
486
+ /**
487
+ * Get a share token by its ID.
488
+ * @summary Get Share Token
489
+ * @param {string} shareTokenId Share token ID
490
+ * @param {*} [options] Override http request option.
491
+ * @throws {RequiredError}
492
+ */
493
+ getShareTokenV1AccessShareTokensShareTokenIdGet: async (shareTokenId, options = {}) => {
494
+ assertParamExists("getShareTokenV1AccessShareTokensShareTokenIdGet", "shareTokenId", shareTokenId);
495
+ const localVarPath = `/v1/access/share-tokens/{share_token_id}`.replace(`{${"share_token_id"}}`, encodeURIComponent(String(shareTokenId)));
496
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
497
+ let baseOptions;
498
+ if (configuration) {
499
+ baseOptions = configuration.baseOptions;
500
+ }
501
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
502
+ const localVarHeaderParameter = {};
503
+ const localVarQueryParameter = {};
504
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
364
505
  setSearchParams(localVarUrlObj, localVarQueryParameter);
365
506
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
366
507
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -499,10 +640,68 @@ var PublicApiAxiosParamCreator = function(configuration) {
499
640
  options: localVarRequestOptions
500
641
  };
501
642
  },
643
+ /**
644
+ * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
645
+ * @summary List Grants
646
+ * @param {ResourceType | null} [resourceType]
647
+ * @param {string | null} [resourceId]
648
+ * @param {SubjectType | null} [subjectType]
649
+ * @param {string | null} [subjectId]
650
+ * @param {boolean | null} [revoked]
651
+ * @param {number} [page]
652
+ * @param {number} [pageSize]
653
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
654
+ * @param {*} [options] Override http request option.
655
+ * @throws {RequiredError}
656
+ */
657
+ listGrantsV1AccessGrantsGet: async (resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options = {}) => {
658
+ const localVarPath = `/v1/access/grants`;
659
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
660
+ let baseOptions;
661
+ if (configuration) {
662
+ baseOptions = configuration.baseOptions;
663
+ }
664
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
665
+ const localVarHeaderParameter = {};
666
+ const localVarQueryParameter = {};
667
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
668
+ if (resourceType !== void 0) {
669
+ localVarQueryParameter["resource_type"] = resourceType;
670
+ }
671
+ if (resourceId !== void 0) {
672
+ localVarQueryParameter["resource_id"] = resourceId;
673
+ }
674
+ if (subjectType !== void 0) {
675
+ localVarQueryParameter["subject_type"] = subjectType;
676
+ }
677
+ if (subjectId !== void 0) {
678
+ localVarQueryParameter["subject_id"] = subjectId;
679
+ }
680
+ if (revoked !== void 0) {
681
+ localVarQueryParameter["revoked"] = revoked;
682
+ }
683
+ if (page !== void 0) {
684
+ localVarQueryParameter["page"] = page;
685
+ }
686
+ if (pageSize !== void 0) {
687
+ localVarQueryParameter["page_size"] = pageSize;
688
+ }
689
+ if (sort) {
690
+ localVarQueryParameter["sort"] = sort;
691
+ }
692
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
693
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
694
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
695
+ return {
696
+ url: toPathString(localVarUrlObj),
697
+ options: localVarRequestOptions
698
+ };
699
+ },
502
700
  /**
503
701
  * 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
504
702
  * @summary List Run Items
505
703
  * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
704
+ * @param {string | null} [shareToken] Share token for accessing shared runs
506
705
  * @param {Array<string> | null} [itemIdIn] Filter for item ids
507
706
  * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
508
707
  * @param {ItemState | null} [state] Filter items by their state
@@ -514,7 +713,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
514
713
  * @param {*} [options] Override http request option.
515
714
  * @throws {RequiredError}
516
715
  */
517
- listRunItemsV1RunsRunIdItemsGet: async (runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options = {}) => {
716
+ listRunItemsV1RunsRunIdItemsGet: async (runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options = {}) => {
518
717
  assertParamExists("listRunItemsV1RunsRunIdItemsGet", "runId", runId);
519
718
  const localVarPath = `/v1/runs/{run_id}/items`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
520
719
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -526,6 +725,9 @@ var PublicApiAxiosParamCreator = function(configuration) {
526
725
  const localVarHeaderParameter = {};
527
726
  const localVarQueryParameter = {};
528
727
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
728
+ if (shareToken !== void 0) {
729
+ localVarQueryParameter["share_token"] = shareToken;
730
+ }
529
731
  if (itemIdIn) {
530
732
  localVarQueryParameter["item_id__in"] = itemIdIn;
531
733
  }
@@ -615,6 +817,55 @@ var PublicApiAxiosParamCreator = function(configuration) {
615
817
  options: localVarRequestOptions
616
818
  };
617
819
  },
820
+ /**
821
+ * List share tokens. Service and Superadmin see all tokens; other users see only their own.
822
+ * @summary List Share Tokens
823
+ * @param {string | null} [runId] Filter by run ID
824
+ * @param {string | null} [createdBy] Filter by share token creator
825
+ * @param {boolean | null} [revoked]
826
+ * @param {number} [page]
827
+ * @param {number} [pageSize]
828
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
829
+ * @param {*} [options] Override http request option.
830
+ * @throws {RequiredError}
831
+ */
832
+ listShareTokensV1AccessShareTokensGet: async (runId, createdBy, revoked, page, pageSize, sort, options = {}) => {
833
+ const localVarPath = `/v1/access/share-tokens`;
834
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
835
+ let baseOptions;
836
+ if (configuration) {
837
+ baseOptions = configuration.baseOptions;
838
+ }
839
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
840
+ const localVarHeaderParameter = {};
841
+ const localVarQueryParameter = {};
842
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
843
+ if (runId !== void 0) {
844
+ localVarQueryParameter["run_id"] = runId;
845
+ }
846
+ if (createdBy !== void 0) {
847
+ localVarQueryParameter["created_by"] = createdBy;
848
+ }
849
+ if (revoked !== void 0) {
850
+ localVarQueryParameter["revoked"] = revoked;
851
+ }
852
+ if (page !== void 0) {
853
+ localVarQueryParameter["page"] = page;
854
+ }
855
+ if (pageSize !== void 0) {
856
+ localVarQueryParameter["page_size"] = pageSize;
857
+ }
858
+ if (sort) {
859
+ localVarQueryParameter["sort"] = sort;
860
+ }
861
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
862
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
863
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
864
+ return {
865
+ url: toPathString(localVarUrlObj),
866
+ options: localVarRequestOptions
867
+ };
868
+ },
618
869
  /**
619
870
  * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
620
871
  * @summary List version documents
@@ -734,6 +985,60 @@ var PublicApiAxiosParamCreator = function(configuration) {
734
985
  url: toPathString(localVarUrlObj),
735
986
  options: localVarRequestOptions
736
987
  };
988
+ },
989
+ /**
990
+ * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
991
+ * @summary Revoke Grant
992
+ * @param {string} grantId Grant ID
993
+ * @param {*} [options] Override http request option.
994
+ * @throws {RequiredError}
995
+ */
996
+ revokeGrantV1AccessGrantsGrantIdDelete: async (grantId, options = {}) => {
997
+ assertParamExists("revokeGrantV1AccessGrantsGrantIdDelete", "grantId", grantId);
998
+ const localVarPath = `/v1/access/grants/{grant_id}`.replace(`{${"grant_id"}}`, encodeURIComponent(String(grantId)));
999
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1000
+ let baseOptions;
1001
+ if (configuration) {
1002
+ baseOptions = configuration.baseOptions;
1003
+ }
1004
+ const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
1005
+ const localVarHeaderParameter = {};
1006
+ const localVarQueryParameter = {};
1007
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
1008
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1009
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1010
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1011
+ return {
1012
+ url: toPathString(localVarUrlObj),
1013
+ options: localVarRequestOptions
1014
+ };
1015
+ },
1016
+ /**
1017
+ * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
1018
+ * @summary Revoke Share Token
1019
+ * @param {string} shareTokenId Share token ID
1020
+ * @param {*} [options] Override http request option.
1021
+ * @throws {RequiredError}
1022
+ */
1023
+ revokeShareTokenV1AccessShareTokensShareTokenIdDelete: async (shareTokenId, options = {}) => {
1024
+ assertParamExists("revokeShareTokenV1AccessShareTokensShareTokenIdDelete", "shareTokenId", shareTokenId);
1025
+ const localVarPath = `/v1/access/share-tokens/{share_token_id}`.replace(`{${"share_token_id"}}`, encodeURIComponent(String(shareTokenId)));
1026
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1027
+ let baseOptions;
1028
+ if (configuration) {
1029
+ baseOptions = configuration.baseOptions;
1030
+ }
1031
+ const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
1032
+ const localVarHeaderParameter = {};
1033
+ const localVarQueryParameter = {};
1034
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
1035
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1036
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1037
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1038
+ return {
1039
+ url: toPathString(localVarUrlObj),
1040
+ options: localVarRequestOptions
1041
+ };
737
1042
  }
738
1043
  };
739
1044
  };
@@ -767,6 +1072,19 @@ var PublicApiFp = function(configuration) {
767
1072
  const localVarOperationServerBasePath = operationServerMap["PublicApi.cancelRunV1RunsRunIdCancelPost"]?.[localVarOperationServerIndex]?.url;
768
1073
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
769
1074
  },
1075
+ /**
1076
+ * Create a grant to share access to a resource with a subject (user or organization).
1077
+ * @summary Create Grant
1078
+ * @param {GrantCreateRequest} grantCreateRequest
1079
+ * @param {*} [options] Override http request option.
1080
+ * @throws {RequiredError}
1081
+ */
1082
+ async createGrantV1AccessGrantsPost(grantCreateRequest, options) {
1083
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createGrantV1AccessGrantsPost(grantCreateRequest, options);
1084
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1085
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.createGrantV1AccessGrantsPost"]?.[localVarOperationServerIndex]?.url;
1086
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1087
+ },
770
1088
  /**
771
1089
  * 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
772
1090
  * @summary Initiate Run
@@ -780,6 +1098,19 @@ var PublicApiFp = function(configuration) {
780
1098
  const localVarOperationServerBasePath = operationServerMap["PublicApi.createRunV1RunsPost"]?.[localVarOperationServerIndex]?.url;
781
1099
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
782
1100
  },
1101
+ /**
1102
+ * Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
1103
+ * @summary Create Share Token
1104
+ * @param {ShareTokenCreateRequest} shareTokenCreateRequest
1105
+ * @param {*} [options] Override http request option.
1106
+ * @throws {RequiredError}
1107
+ */
1108
+ async createShareTokenV1AccessShareTokensPost(shareTokenCreateRequest, options) {
1109
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createShareTokenV1AccessShareTokensPost(shareTokenCreateRequest, options);
1110
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1111
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.createShareTokenV1AccessShareTokensPost"]?.[localVarOperationServerIndex]?.url;
1112
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1113
+ },
783
1114
  /**
784
1115
  * 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.
785
1116
  * @summary Delete Run Items
@@ -798,25 +1129,40 @@ var PublicApiFp = function(configuration) {
798
1129
  * @summary Get Artifact Url
799
1130
  * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
800
1131
  * @param {string} artifactId The artifact id to download
1132
+ * @param {string | null} [shareToken] Share token for accessing shared runs
801
1133
  * @param {*} [options] Override http request option.
802
1134
  * @throws {RequiredError}
803
1135
  */
804
- async getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, options) {
805
- const localVarAxiosArgs = await localVarAxiosParamCreator.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, options);
1136
+ async getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, shareToken, options) {
1137
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId, artifactId, shareToken, options);
806
1138
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
807
1139
  const localVarOperationServerBasePath = operationServerMap["PublicApi.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet"]?.[localVarOperationServerIndex]?.url;
808
1140
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
809
1141
  },
1142
+ /**
1143
+ * Get a grant by its ID.
1144
+ * @summary Get Grant
1145
+ * @param {string} grantId Grant ID
1146
+ * @param {*} [options] Override http request option.
1147
+ * @throws {RequiredError}
1148
+ */
1149
+ async getGrantV1AccessGrantsGrantIdGet(grantId, options) {
1150
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGrantV1AccessGrantsGrantIdGet(grantId, options);
1151
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1152
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.getGrantV1AccessGrantsGrantIdGet"]?.[localVarOperationServerIndex]?.url;
1153
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1154
+ },
810
1155
  /**
811
1156
  * Retrieve details of a specific item (slide) by its external ID and the run ID.
812
1157
  * @summary Get Item By Run
813
1158
  * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
814
1159
  * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
1160
+ * @param {string | null} [shareToken] Share token for accessing shared runs
815
1161
  * @param {*} [options] Override http request option.
816
1162
  * @throws {RequiredError}
817
1163
  */
818
- async getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options) {
819
- const localVarAxiosArgs = await localVarAxiosParamCreator.getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options);
1164
+ async getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, shareToken, options) {
1165
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, shareToken, options);
820
1166
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
821
1167
  const localVarOperationServerBasePath = operationServerMap["PublicApi.getItemByRunV1RunsRunIdItemsExternalIdGet"]?.[localVarOperationServerIndex]?.url;
822
1168
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -834,18 +1180,32 @@ var PublicApiFp = function(configuration) {
834
1180
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
835
1181
  },
836
1182
  /**
837
- * 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.
1183
+ * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
838
1184
  * @summary Get run details
839
1185
  * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1186
+ * @param {string | null} [shareToken] Share token for accessing shared runs
840
1187
  * @param {*} [options] Override http request option.
841
1188
  * @throws {RequiredError}
842
1189
  */
843
- async getRunV1RunsRunIdGet(runId, options) {
844
- const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsRunIdGet(runId, options);
1190
+ async getRunV1RunsRunIdGet(runId, shareToken, options) {
1191
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsRunIdGet(runId, shareToken, options);
845
1192
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
846
1193
  const localVarOperationServerBasePath = operationServerMap["PublicApi.getRunV1RunsRunIdGet"]?.[localVarOperationServerIndex]?.url;
847
1194
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
848
1195
  },
1196
+ /**
1197
+ * Get a share token by its ID.
1198
+ * @summary Get Share Token
1199
+ * @param {string} shareTokenId Share token ID
1200
+ * @param {*} [options] Override http request option.
1201
+ * @throws {RequiredError}
1202
+ */
1203
+ async getShareTokenV1AccessShareTokensShareTokenIdGet(shareTokenId, options) {
1204
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getShareTokenV1AccessShareTokensShareTokenIdGet(shareTokenId, options);
1205
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1206
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.getShareTokenV1AccessShareTokensShareTokenIdGet"]?.[localVarOperationServerIndex]?.url;
1207
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1208
+ },
849
1209
  /**
850
1210
  * Return metadata for a single public document attached to an application version.
851
1211
  * @summary Get version document metadata
@@ -906,10 +1266,31 @@ var PublicApiFp = function(configuration) {
906
1266
  const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationsV1ApplicationsGet"]?.[localVarOperationServerIndex]?.url;
907
1267
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
908
1268
  },
1269
+ /**
1270
+ * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
1271
+ * @summary List Grants
1272
+ * @param {ResourceType | null} [resourceType]
1273
+ * @param {string | null} [resourceId]
1274
+ * @param {SubjectType | null} [subjectType]
1275
+ * @param {string | null} [subjectId]
1276
+ * @param {boolean | null} [revoked]
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.
1280
+ * @param {*} [options] Override http request option.
1281
+ * @throws {RequiredError}
1282
+ */
1283
+ async listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options) {
1284
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listGrantsV1AccessGrantsGet(resourceType, resourceId, subjectType, subjectId, revoked, page, pageSize, sort, options);
1285
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1286
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listGrantsV1AccessGrantsGet"]?.[localVarOperationServerIndex]?.url;
1287
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1288
+ },
909
1289
  /**
910
1290
  * 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
911
1291
  * @summary List Run Items
912
1292
  * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
1293
+ * @param {string | null} [shareToken] Share token for accessing shared runs
913
1294
  * @param {Array<string> | null} [itemIdIn] Filter for item ids
914
1295
  * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
915
1296
  * @param {ItemState | null} [state] Filter items by their state
@@ -921,8 +1302,8 @@ var PublicApiFp = function(configuration) {
921
1302
  * @param {*} [options] Override http request option.
922
1303
  * @throws {RequiredError}
923
1304
  */
924
- async listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options) {
925
- const localVarAxiosArgs = await localVarAxiosParamCreator.listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options);
1305
+ async listRunItemsV1RunsRunIdItemsGet(runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options) {
1306
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listRunItemsV1RunsRunIdItemsGet(runId, shareToken, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options);
926
1307
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
927
1308
  const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunItemsV1RunsRunIdItemsGet"]?.[localVarOperationServerIndex]?.url;
928
1309
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -947,6 +1328,24 @@ var PublicApiFp = function(configuration) {
947
1328
  const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunsV1RunsGet"]?.[localVarOperationServerIndex]?.url;
948
1329
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
949
1330
  },
1331
+ /**
1332
+ * List share tokens. Service and Superadmin see all tokens; other users see only their own.
1333
+ * @summary List Share Tokens
1334
+ * @param {string | null} [runId] Filter by run ID
1335
+ * @param {string | null} [createdBy] Filter by share token creator
1336
+ * @param {boolean | null} [revoked]
1337
+ * @param {number} [page]
1338
+ * @param {number} [pageSize]
1339
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order.
1340
+ * @param {*} [options] Override http request option.
1341
+ * @throws {RequiredError}
1342
+ */
1343
+ async listShareTokensV1AccessShareTokensGet(runId, createdBy, revoked, page, pageSize, sort, options) {
1344
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listShareTokensV1AccessShareTokensGet(runId, createdBy, revoked, page, pageSize, sort, options);
1345
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1346
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listShareTokensV1AccessShareTokensGet"]?.[localVarOperationServerIndex]?.url;
1347
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1348
+ },
950
1349
  /**
951
1350
  * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
952
1351
  * @summary List version documents
@@ -1002,6 +1401,32 @@ var PublicApiFp = function(configuration) {
1002
1401
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1003
1402
  const localVarOperationServerBasePath = operationServerMap["PublicApi.readApplicationByIdV1ApplicationsApplicationIdGet"]?.[localVarOperationServerIndex]?.url;
1004
1403
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1404
+ },
1405
+ /**
1406
+ * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
1407
+ * @summary Revoke Grant
1408
+ * @param {string} grantId Grant ID
1409
+ * @param {*} [options] Override http request option.
1410
+ * @throws {RequiredError}
1411
+ */
1412
+ async revokeGrantV1AccessGrantsGrantIdDelete(grantId, options) {
1413
+ const localVarAxiosArgs = await localVarAxiosParamCreator.revokeGrantV1AccessGrantsGrantIdDelete(grantId, options);
1414
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1415
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.revokeGrantV1AccessGrantsGrantIdDelete"]?.[localVarOperationServerIndex]?.url;
1416
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1417
+ },
1418
+ /**
1419
+ * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
1420
+ * @summary Revoke Share Token
1421
+ * @param {string} shareTokenId Share token ID
1422
+ * @param {*} [options] Override http request option.
1423
+ * @throws {RequiredError}
1424
+ */
1425
+ async revokeShareTokenV1AccessShareTokensShareTokenIdDelete(shareTokenId, options) {
1426
+ const localVarAxiosArgs = await localVarAxiosParamCreator.revokeShareTokenV1AccessShareTokensShareTokenIdDelete(shareTokenId, options);
1427
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1428
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.revokeShareTokenV1AccessShareTokensShareTokenIdDelete"]?.[localVarOperationServerIndex]?.url;
1429
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1005
1430
  }
1006
1431
  };
1007
1432
  };
@@ -1028,6 +1453,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
1028
1453
  cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
1029
1454
  return localVarFp.cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(axios, basePath));
1030
1455
  },
1456
+ /**
1457
+ * Create a grant to share access to a resource with a subject (user or organization).
1458
+ * @summary Create Grant
1459
+ * @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
1460
+ * @param {*} [options] Override http request option.
1461
+ * @throws {RequiredError}
1462
+ */
1463
+ createGrantV1AccessGrantsPost(requestParameters, options) {
1464
+ return localVarFp.createGrantV1AccessGrantsPost(requestParameters.grantCreateRequest, options).then((request) => request(axios, basePath));
1465
+ },
1031
1466
  /**
1032
1467
  * 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
1033
1468
  * @summary Initiate Run
@@ -1038,6 +1473,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
1038
1473
  createRunV1RunsPost(requestParameters, options) {
1039
1474
  return localVarFp.createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(axios, basePath));
1040
1475
  },
1476
+ /**
1477
+ * Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
1478
+ * @summary Create Share Token
1479
+ * @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
1480
+ * @param {*} [options] Override http request option.
1481
+ * @throws {RequiredError}
1482
+ */
1483
+ createShareTokenV1AccessShareTokensPost(requestParameters, options) {
1484
+ return localVarFp.createShareTokenV1AccessShareTokensPost(requestParameters.shareTokenCreateRequest, options).then((request) => request(axios, basePath));
1485
+ },
1041
1486
  /**
1042
1487
  * 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.
1043
1488
  * @summary Delete Run Items
@@ -1056,7 +1501,17 @@ var PublicApiFactory = function(configuration, basePath, axios) {
1056
1501
  * @throws {RequiredError}
1057
1502
  */
1058
1503
  getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters, options) {
1059
- return localVarFp.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, options).then((request) => request(axios, basePath));
1504
+ return localVarFp.getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
1505
+ },
1506
+ /**
1507
+ * Get a grant by its ID.
1508
+ * @summary Get Grant
1509
+ * @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
1510
+ * @param {*} [options] Override http request option.
1511
+ * @throws {RequiredError}
1512
+ */
1513
+ getGrantV1AccessGrantsGrantIdGet(requestParameters, options) {
1514
+ return localVarFp.getGrantV1AccessGrantsGrantIdGet(requestParameters.grantId, options).then((request) => request(axios, basePath));
1060
1515
  },
1061
1516
  /**
1062
1517
  * Retrieve details of a specific item (slide) by its external ID and the run ID.
@@ -1066,7 +1521,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
1066
1521
  * @throws {RequiredError}
1067
1522
  */
1068
1523
  getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
1069
- return localVarFp.getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(axios, basePath));
1524
+ return localVarFp.getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
1070
1525
  },
1071
1526
  /**
1072
1527
  * 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)
@@ -1078,14 +1533,24 @@ var PublicApiFactory = function(configuration, basePath, axios) {
1078
1533
  return localVarFp.getMeV1MeGet(options).then((request) => request(axios, basePath));
1079
1534
  },
1080
1535
  /**
1081
- * 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.
1536
+ * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
1082
1537
  * @summary Get run details
1083
1538
  * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
1084
1539
  * @param {*} [options] Override http request option.
1085
1540
  * @throws {RequiredError}
1086
1541
  */
1087
1542
  getRunV1RunsRunIdGet(requestParameters, options) {
1088
- return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(axios, basePath));
1543
+ return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, requestParameters.shareToken, options).then((request) => request(axios, basePath));
1544
+ },
1545
+ /**
1546
+ * Get a share token by its ID.
1547
+ * @summary Get Share Token
1548
+ * @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
1549
+ * @param {*} [options] Override http request option.
1550
+ * @throws {RequiredError}
1551
+ */
1552
+ getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters, options) {
1553
+ return localVarFp.getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters.shareTokenId, options).then((request) => request(axios, basePath));
1089
1554
  },
1090
1555
  /**
1091
1556
  * Return metadata for a single public document attached to an application version.
@@ -1127,6 +1592,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
1127
1592
  listApplicationsV1ApplicationsGet(requestParameters = {}, options) {
1128
1593
  return localVarFp.listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
1129
1594
  },
1595
+ /**
1596
+ * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
1597
+ * @summary List Grants
1598
+ * @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
1599
+ * @param {*} [options] Override http request option.
1600
+ * @throws {RequiredError}
1601
+ */
1602
+ listGrantsV1AccessGrantsGet(requestParameters = {}, options) {
1603
+ return localVarFp.listGrantsV1AccessGrantsGet(requestParameters.resourceType, requestParameters.resourceId, requestParameters.subjectType, requestParameters.subjectId, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
1604
+ },
1130
1605
  /**
1131
1606
  * 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
1132
1607
  * @summary List Run Items
@@ -1135,7 +1610,7 @@ var PublicApiFactory = function(configuration, basePath, axios) {
1135
1610
  * @throws {RequiredError}
1136
1611
  */
1137
1612
  listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
1138
- return localVarFp.listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
1613
+ return localVarFp.listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.shareToken, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
1139
1614
  },
1140
1615
  /**
1141
1616
  * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
@@ -1147,6 +1622,16 @@ var PublicApiFactory = function(configuration, basePath, axios) {
1147
1622
  listRunsV1RunsGet(requestParameters = {}, options) {
1148
1623
  return localVarFp.listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(axios, basePath));
1149
1624
  },
1625
+ /**
1626
+ * List share tokens. Service and Superadmin see all tokens; other users see only their own.
1627
+ * @summary List Share Tokens
1628
+ * @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
1629
+ * @param {*} [options] Override http request option.
1630
+ * @throws {RequiredError}
1631
+ */
1632
+ listShareTokensV1AccessShareTokensGet(requestParameters = {}, options) {
1633
+ return localVarFp.listShareTokensV1AccessShareTokensGet(requestParameters.runId, requestParameters.createdBy, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
1634
+ },
1150
1635
  /**
1151
1636
  * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
1152
1637
  * @summary List version documents
@@ -1186,6 +1671,26 @@ var PublicApiFactory = function(configuration, basePath, axios) {
1186
1671
  */
1187
1672
  readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
1188
1673
  return localVarFp.readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(axios, basePath));
1674
+ },
1675
+ /**
1676
+ * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
1677
+ * @summary Revoke Grant
1678
+ * @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
1679
+ * @param {*} [options] Override http request option.
1680
+ * @throws {RequiredError}
1681
+ */
1682
+ revokeGrantV1AccessGrantsGrantIdDelete(requestParameters, options) {
1683
+ return localVarFp.revokeGrantV1AccessGrantsGrantIdDelete(requestParameters.grantId, options).then((request) => request(axios, basePath));
1684
+ },
1685
+ /**
1686
+ * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
1687
+ * @summary Revoke Share Token
1688
+ * @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
1689
+ * @param {*} [options] Override http request option.
1690
+ * @throws {RequiredError}
1691
+ */
1692
+ revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters, options) {
1693
+ return localVarFp.revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters.shareTokenId, options).then((request) => request(axios, basePath));
1189
1694
  }
1190
1695
  };
1191
1696
  };
@@ -1212,6 +1717,17 @@ var PublicApi = class extends BaseAPI {
1212
1717
  cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
1213
1718
  return PublicApiFp(this.configuration).cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
1214
1719
  }
1720
+ /**
1721
+ * Create a grant to share access to a resource with a subject (user or organization).
1722
+ * @summary Create Grant
1723
+ * @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
1724
+ * @param {*} [options] Override http request option.
1725
+ * @throws {RequiredError}
1726
+ * @memberof PublicApi
1727
+ */
1728
+ createGrantV1AccessGrantsPost(requestParameters, options) {
1729
+ return PublicApiFp(this.configuration).createGrantV1AccessGrantsPost(requestParameters.grantCreateRequest, options).then((request) => request(this.axios, this.basePath));
1730
+ }
1215
1731
  /**
1216
1732
  * 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
1217
1733
  * @summary Initiate Run
@@ -1223,6 +1739,17 @@ var PublicApi = class extends BaseAPI {
1223
1739
  createRunV1RunsPost(requestParameters, options) {
1224
1740
  return PublicApiFp(this.configuration).createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(this.axios, this.basePath));
1225
1741
  }
1742
+ /**
1743
+ * Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
1744
+ * @summary Create Share Token
1745
+ * @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
1746
+ * @param {*} [options] Override http request option.
1747
+ * @throws {RequiredError}
1748
+ * @memberof PublicApi
1749
+ */
1750
+ createShareTokenV1AccessShareTokensPost(requestParameters, options) {
1751
+ return PublicApiFp(this.configuration).createShareTokenV1AccessShareTokensPost(requestParameters.shareTokenCreateRequest, options).then((request) => request(this.axios, this.basePath));
1752
+ }
1226
1753
  /**
1227
1754
  * 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.
1228
1755
  * @summary Delete Run Items
@@ -1243,7 +1770,18 @@ var PublicApi = class extends BaseAPI {
1243
1770
  * @memberof PublicApi
1244
1771
  */
1245
1772
  getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters, options) {
1246
- return PublicApiFp(this.configuration).getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, options).then((request) => request(this.axios, this.basePath));
1773
+ return PublicApiFp(this.configuration).getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters.runId, requestParameters.artifactId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
1774
+ }
1775
+ /**
1776
+ * Get a grant by its ID.
1777
+ * @summary Get Grant
1778
+ * @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
1779
+ * @param {*} [options] Override http request option.
1780
+ * @throws {RequiredError}
1781
+ * @memberof PublicApi
1782
+ */
1783
+ getGrantV1AccessGrantsGrantIdGet(requestParameters, options) {
1784
+ return PublicApiFp(this.configuration).getGrantV1AccessGrantsGrantIdGet(requestParameters.grantId, options).then((request) => request(this.axios, this.basePath));
1247
1785
  }
1248
1786
  /**
1249
1787
  * Retrieve details of a specific item (slide) by its external ID and the run ID.
@@ -1254,7 +1792,7 @@ var PublicApi = class extends BaseAPI {
1254
1792
  * @memberof PublicApi
1255
1793
  */
1256
1794
  getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
1257
- return PublicApiFp(this.configuration).getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(this.axios, this.basePath));
1795
+ return PublicApiFp(this.configuration).getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
1258
1796
  }
1259
1797
  /**
1260
1798
  * 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)
@@ -1267,7 +1805,7 @@ var PublicApi = class extends BaseAPI {
1267
1805
  return PublicApiFp(this.configuration).getMeV1MeGet(options).then((request) => request(this.axios, this.basePath));
1268
1806
  }
1269
1807
  /**
1270
- * 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.
1808
+ * This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
1271
1809
  * @summary Get run details
1272
1810
  * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
1273
1811
  * @param {*} [options] Override http request option.
@@ -1275,7 +1813,18 @@ var PublicApi = class extends BaseAPI {
1275
1813
  * @memberof PublicApi
1276
1814
  */
1277
1815
  getRunV1RunsRunIdGet(requestParameters, options) {
1278
- return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
1816
+ return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, requestParameters.shareToken, options).then((request) => request(this.axios, this.basePath));
1817
+ }
1818
+ /**
1819
+ * Get a share token by its ID.
1820
+ * @summary Get Share Token
1821
+ * @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
1822
+ * @param {*} [options] Override http request option.
1823
+ * @throws {RequiredError}
1824
+ * @memberof PublicApi
1825
+ */
1826
+ getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters, options) {
1827
+ return PublicApiFp(this.configuration).getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters.shareTokenId, options).then((request) => request(this.axios, this.basePath));
1279
1828
  }
1280
1829
  /**
1281
1830
  * Return metadata for a single public document attached to an application version.
@@ -1321,6 +1870,17 @@ var PublicApi = class extends BaseAPI {
1321
1870
  listApplicationsV1ApplicationsGet(requestParameters = {}, options) {
1322
1871
  return PublicApiFp(this.configuration).listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
1323
1872
  }
1873
+ /**
1874
+ * List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
1875
+ * @summary List Grants
1876
+ * @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
1877
+ * @param {*} [options] Override http request option.
1878
+ * @throws {RequiredError}
1879
+ * @memberof PublicApi
1880
+ */
1881
+ listGrantsV1AccessGrantsGet(requestParameters = {}, options) {
1882
+ return PublicApiFp(this.configuration).listGrantsV1AccessGrantsGet(requestParameters.resourceType, requestParameters.resourceId, requestParameters.subjectType, requestParameters.subjectId, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
1883
+ }
1324
1884
  /**
1325
1885
  * 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
1326
1886
  * @summary List Run Items
@@ -1330,7 +1890,7 @@ var PublicApi = class extends BaseAPI {
1330
1890
  * @memberof PublicApi
1331
1891
  */
1332
1892
  listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
1333
- return PublicApiFp(this.configuration).listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
1893
+ return PublicApiFp(this.configuration).listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.shareToken, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
1334
1894
  }
1335
1895
  /**
1336
1896
  * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
@@ -1343,6 +1903,17 @@ var PublicApi = class extends BaseAPI {
1343
1903
  listRunsV1RunsGet(requestParameters = {}, options) {
1344
1904
  return PublicApiFp(this.configuration).listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.forOrganization, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
1345
1905
  }
1906
+ /**
1907
+ * List share tokens. Service and Superadmin see all tokens; other users see only their own.
1908
+ * @summary List Share Tokens
1909
+ * @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
1910
+ * @param {*} [options] Override http request option.
1911
+ * @throws {RequiredError}
1912
+ * @memberof PublicApi
1913
+ */
1914
+ listShareTokensV1AccessShareTokensGet(requestParameters = {}, options) {
1915
+ return PublicApiFp(this.configuration).listShareTokensV1AccessShareTokensGet(requestParameters.runId, requestParameters.createdBy, requestParameters.revoked, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
1916
+ }
1346
1917
  /**
1347
1918
  * List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
1348
1919
  * @summary List version documents
@@ -1387,6 +1958,28 @@ var PublicApi = class extends BaseAPI {
1387
1958
  readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
1388
1959
  return PublicApiFp(this.configuration).readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(this.axios, this.basePath));
1389
1960
  }
1961
+ /**
1962
+ * Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
1963
+ * @summary Revoke Grant
1964
+ * @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
1965
+ * @param {*} [options] Override http request option.
1966
+ * @throws {RequiredError}
1967
+ * @memberof PublicApi
1968
+ */
1969
+ revokeGrantV1AccessGrantsGrantIdDelete(requestParameters, options) {
1970
+ return PublicApiFp(this.configuration).revokeGrantV1AccessGrantsGrantIdDelete(requestParameters.grantId, options).then((request) => request(this.axios, this.basePath));
1971
+ }
1972
+ /**
1973
+ * Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
1974
+ * @summary Revoke Share Token
1975
+ * @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
1976
+ * @param {*} [options] Override http request option.
1977
+ * @throws {RequiredError}
1978
+ * @memberof PublicApi
1979
+ */
1980
+ revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters, options) {
1981
+ return PublicApiFp(this.configuration).revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters.shareTokenId, options).then((request) => request(this.axios, this.basePath));
1982
+ }
1390
1983
  };
1391
1984
 
1392
1985
  // src/generated/configuration.ts
@@ -2465,6 +3058,7 @@ exports.AuthenticationError = AuthenticationError;
2465
3058
  exports.BaseError = BaseError;
2466
3059
  exports.Configuration = Configuration;
2467
3060
  exports.ConfigurationError = ConfigurationError;
3061
+ exports.GrantRelation = GrantRelation;
2468
3062
  exports.ItemOutput = ItemOutput;
2469
3063
  exports.ItemState = ItemState;
2470
3064
  exports.ItemTerminationReason = ItemTerminationReason;
@@ -2475,9 +3069,11 @@ exports.PublicApi = PublicApi;
2475
3069
  exports.PublicApiAxiosParamCreator = PublicApiAxiosParamCreator;
2476
3070
  exports.PublicApiFactory = PublicApiFactory;
2477
3071
  exports.PublicApiFp = PublicApiFp;
3072
+ exports.ResourceType = ResourceType;
2478
3073
  exports.RunOutput = RunOutput;
2479
3074
  exports.RunState = RunState;
2480
3075
  exports.RunTerminationReason = RunTerminationReason;
3076
+ exports.SubjectType = SubjectType;
2481
3077
  exports.VersionDocumentVisibility = VersionDocumentVisibility;
2482
3078
  exports.canDownloadItem = canDownloadItem;
2483
3079
  exports.canDownloadRunItems = canDownloadRunItems;