@aignostics/sdk 3.4.0 → 3.5.1
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/aignostics-sdk-3.5.1.tgz +0 -0
- package/dist/{api-DXw7V8bK.d.cts → api-B0sQ1mLM.d.cts} +844 -18
- package/dist/{api-DXw7V8bK.d.ts → api-B0sQ1mLM.d.ts} +844 -18
- package/dist/index.cjs +674 -41
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +16 -10
- package/dist/index.d.ts +16 -10
- package/dist/index.js +672 -42
- package/dist/index.js.map +1 -1
- package/dist/test-utils/http-mocks.d.cts +1 -1
- package/dist/test-utils/http-mocks.d.ts +1 -1
- package/package.json +1 -1
- package/dist/aignostics-sdk-3.4.0.tgz +0 -0
|
@@ -5,7 +5,7 @@ import { RawAxiosRequestConfig, AxiosInstance, AxiosPromise } from 'axios';
|
|
|
5
5
|
* Aignostics Platform API
|
|
6
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
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.7.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -97,7 +97,7 @@ declare class Configuration {
|
|
|
97
97
|
* Aignostics Platform API
|
|
98
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
99
|
*
|
|
100
|
-
* The version of the OpenAPI document: 1.
|
|
100
|
+
* The version of the OpenAPI document: 1.7.0
|
|
101
101
|
*
|
|
102
102
|
*
|
|
103
103
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -288,6 +288,121 @@ interface CustomMetadataUpdateResponse {
|
|
|
288
288
|
*/
|
|
289
289
|
'custom_metadata_checksum': string | null;
|
|
290
290
|
}
|
|
291
|
+
/**
|
|
292
|
+
*
|
|
293
|
+
* @export
|
|
294
|
+
* @interface GrantCreateRequest
|
|
295
|
+
*/
|
|
296
|
+
interface GrantCreateRequest {
|
|
297
|
+
/**
|
|
298
|
+
*
|
|
299
|
+
* @type {ResourceType}
|
|
300
|
+
* @memberof GrantCreateRequest
|
|
301
|
+
*/
|
|
302
|
+
'resource_type': ResourceType;
|
|
303
|
+
/**
|
|
304
|
+
*
|
|
305
|
+
* @type {string}
|
|
306
|
+
* @memberof GrantCreateRequest
|
|
307
|
+
*/
|
|
308
|
+
'resource_id': string;
|
|
309
|
+
/**
|
|
310
|
+
*
|
|
311
|
+
* @type {SubjectType}
|
|
312
|
+
* @memberof GrantCreateRequest
|
|
313
|
+
*/
|
|
314
|
+
'subject_type': SubjectType;
|
|
315
|
+
/**
|
|
316
|
+
*
|
|
317
|
+
* @type {string}
|
|
318
|
+
* @memberof GrantCreateRequest
|
|
319
|
+
*/
|
|
320
|
+
'subject_id'?: string | null;
|
|
321
|
+
/**
|
|
322
|
+
*
|
|
323
|
+
* @type {string}
|
|
324
|
+
* @memberof GrantCreateRequest
|
|
325
|
+
*/
|
|
326
|
+
'subject_email'?: string | null;
|
|
327
|
+
/**
|
|
328
|
+
*
|
|
329
|
+
* @type {GrantRelation}
|
|
330
|
+
* @memberof GrantCreateRequest
|
|
331
|
+
*/
|
|
332
|
+
'relation': GrantRelation;
|
|
333
|
+
}
|
|
334
|
+
/**
|
|
335
|
+
*
|
|
336
|
+
* @export
|
|
337
|
+
* @interface GrantReadResponse
|
|
338
|
+
*/
|
|
339
|
+
interface GrantReadResponse {
|
|
340
|
+
/**
|
|
341
|
+
*
|
|
342
|
+
* @type {string}
|
|
343
|
+
* @memberof GrantReadResponse
|
|
344
|
+
*/
|
|
345
|
+
'grant_id': string;
|
|
346
|
+
/**
|
|
347
|
+
*
|
|
348
|
+
* @type {ResourceType}
|
|
349
|
+
* @memberof GrantReadResponse
|
|
350
|
+
*/
|
|
351
|
+
'resource_type': ResourceType;
|
|
352
|
+
/**
|
|
353
|
+
*
|
|
354
|
+
* @type {string}
|
|
355
|
+
* @memberof GrantReadResponse
|
|
356
|
+
*/
|
|
357
|
+
'resource_id': string;
|
|
358
|
+
/**
|
|
359
|
+
*
|
|
360
|
+
* @type {SubjectType}
|
|
361
|
+
* @memberof GrantReadResponse
|
|
362
|
+
*/
|
|
363
|
+
'subject_type': SubjectType;
|
|
364
|
+
/**
|
|
365
|
+
*
|
|
366
|
+
* @type {string}
|
|
367
|
+
* @memberof GrantReadResponse
|
|
368
|
+
*/
|
|
369
|
+
'subject_id': string;
|
|
370
|
+
/**
|
|
371
|
+
*
|
|
372
|
+
* @type {GrantRelation}
|
|
373
|
+
* @memberof GrantReadResponse
|
|
374
|
+
*/
|
|
375
|
+
'relation': GrantRelation;
|
|
376
|
+
/**
|
|
377
|
+
*
|
|
378
|
+
* @type {string}
|
|
379
|
+
* @memberof GrantReadResponse
|
|
380
|
+
*/
|
|
381
|
+
'created_by': string;
|
|
382
|
+
/**
|
|
383
|
+
*
|
|
384
|
+
* @type {string}
|
|
385
|
+
* @memberof GrantReadResponse
|
|
386
|
+
*/
|
|
387
|
+
'created_at': string;
|
|
388
|
+
/**
|
|
389
|
+
*
|
|
390
|
+
* @type {boolean}
|
|
391
|
+
* @memberof GrantReadResponse
|
|
392
|
+
*/
|
|
393
|
+
'revoked': boolean;
|
|
394
|
+
}
|
|
395
|
+
/**
|
|
396
|
+
*
|
|
397
|
+
* @export
|
|
398
|
+
* @enum {string}
|
|
399
|
+
*/
|
|
400
|
+
declare const GrantRelation: {
|
|
401
|
+
readonly Owner: "owner";
|
|
402
|
+
readonly Editor: "editor";
|
|
403
|
+
readonly Viewer: "viewer";
|
|
404
|
+
};
|
|
405
|
+
type GrantRelation = typeof GrantRelation[keyof typeof GrantRelation];
|
|
291
406
|
/**
|
|
292
407
|
*
|
|
293
408
|
* @export
|
|
@@ -743,6 +858,18 @@ declare const OutputArtifactVisibility: {
|
|
|
743
858
|
readonly External: "EXTERNAL";
|
|
744
859
|
};
|
|
745
860
|
type OutputArtifactVisibility = typeof OutputArtifactVisibility[keyof typeof OutputArtifactVisibility];
|
|
861
|
+
/**
|
|
862
|
+
*
|
|
863
|
+
* @export
|
|
864
|
+
* @enum {string}
|
|
865
|
+
*/
|
|
866
|
+
declare const ResourceType: {
|
|
867
|
+
readonly Run: "run";
|
|
868
|
+
readonly Item: "item";
|
|
869
|
+
readonly OutputArtifact: "output_artifact";
|
|
870
|
+
readonly ShareToken: "share_token";
|
|
871
|
+
};
|
|
872
|
+
type ResourceType = typeof ResourceType[keyof typeof ResourceType];
|
|
746
873
|
/**
|
|
747
874
|
* Request schema for `Initiate Run` endpoint. It describes which application version is chosen, and which user data should be processed.
|
|
748
875
|
* @export
|
|
@@ -775,6 +902,14 @@ interface RunCreationRequest {
|
|
|
775
902
|
* @memberof RunCreationRequest
|
|
776
903
|
*/
|
|
777
904
|
'scheduling'?: SchedulingRequest | null;
|
|
905
|
+
/**
|
|
906
|
+
*
|
|
907
|
+
* @type {{ [key: string]: any; }}
|
|
908
|
+
* @memberof RunCreationRequest
|
|
909
|
+
*/
|
|
910
|
+
'callback_context'?: {
|
|
911
|
+
[key: string]: any;
|
|
912
|
+
} | null;
|
|
778
913
|
/**
|
|
779
914
|
* List of items (slides) to process. Each item represents a whole slide image (WSI) with its associated metadata and artifacts
|
|
780
915
|
* @type {Array<ItemCreationRequest>}
|
|
@@ -941,6 +1076,12 @@ interface RunReadResponse {
|
|
|
941
1076
|
* @memberof RunReadResponse
|
|
942
1077
|
*/
|
|
943
1078
|
'submitted_by': string;
|
|
1079
|
+
/**
|
|
1080
|
+
*
|
|
1081
|
+
* @type {string}
|
|
1082
|
+
* @memberof RunReadResponse
|
|
1083
|
+
*/
|
|
1084
|
+
'organization_id'?: string | null;
|
|
944
1085
|
/**
|
|
945
1086
|
*
|
|
946
1087
|
* @type {string}
|
|
@@ -1026,6 +1167,99 @@ interface SchedulingResponse {
|
|
|
1026
1167
|
*/
|
|
1027
1168
|
'deadline'?: string | null;
|
|
1028
1169
|
}
|
|
1170
|
+
/**
|
|
1171
|
+
*
|
|
1172
|
+
* @export
|
|
1173
|
+
* @interface ShareTokenCreateRequest
|
|
1174
|
+
*/
|
|
1175
|
+
interface ShareTokenCreateRequest {
|
|
1176
|
+
/**
|
|
1177
|
+
*
|
|
1178
|
+
* @type {string}
|
|
1179
|
+
* @memberof ShareTokenCreateRequest
|
|
1180
|
+
*/
|
|
1181
|
+
'expires_at'?: string | null;
|
|
1182
|
+
}
|
|
1183
|
+
/**
|
|
1184
|
+
* Returned only on POST — includes the one-time share_token.
|
|
1185
|
+
* @export
|
|
1186
|
+
* @interface ShareTokenCreateResponse
|
|
1187
|
+
*/
|
|
1188
|
+
interface ShareTokenCreateResponse {
|
|
1189
|
+
/**
|
|
1190
|
+
*
|
|
1191
|
+
* @type {string}
|
|
1192
|
+
* @memberof ShareTokenCreateResponse
|
|
1193
|
+
*/
|
|
1194
|
+
'share_token_id': string;
|
|
1195
|
+
/**
|
|
1196
|
+
*
|
|
1197
|
+
* @type {string}
|
|
1198
|
+
* @memberof ShareTokenCreateResponse
|
|
1199
|
+
*/
|
|
1200
|
+
'share_token': string;
|
|
1201
|
+
/**
|
|
1202
|
+
*
|
|
1203
|
+
* @type {string}
|
|
1204
|
+
* @memberof ShareTokenCreateResponse
|
|
1205
|
+
*/
|
|
1206
|
+
'created_at': string;
|
|
1207
|
+
/**
|
|
1208
|
+
*
|
|
1209
|
+
* @type {string}
|
|
1210
|
+
* @memberof ShareTokenCreateResponse
|
|
1211
|
+
*/
|
|
1212
|
+
'expires_at': string | null;
|
|
1213
|
+
/**
|
|
1214
|
+
*
|
|
1215
|
+
* @type {boolean}
|
|
1216
|
+
* @memberof ShareTokenCreateResponse
|
|
1217
|
+
*/
|
|
1218
|
+
'revoked': boolean;
|
|
1219
|
+
}
|
|
1220
|
+
/**
|
|
1221
|
+
* Returned on GET endpoints — omits share_token.
|
|
1222
|
+
* @export
|
|
1223
|
+
* @interface ShareTokenReadResponse
|
|
1224
|
+
*/
|
|
1225
|
+
interface ShareTokenReadResponse {
|
|
1226
|
+
/**
|
|
1227
|
+
*
|
|
1228
|
+
* @type {string}
|
|
1229
|
+
* @memberof ShareTokenReadResponse
|
|
1230
|
+
*/
|
|
1231
|
+
'share_token_id': string;
|
|
1232
|
+
/**
|
|
1233
|
+
*
|
|
1234
|
+
* @type {string}
|
|
1235
|
+
* @memberof ShareTokenReadResponse
|
|
1236
|
+
*/
|
|
1237
|
+
'created_at': string;
|
|
1238
|
+
/**
|
|
1239
|
+
*
|
|
1240
|
+
* @type {string}
|
|
1241
|
+
* @memberof ShareTokenReadResponse
|
|
1242
|
+
*/
|
|
1243
|
+
'expires_at': string | null;
|
|
1244
|
+
/**
|
|
1245
|
+
*
|
|
1246
|
+
* @type {boolean}
|
|
1247
|
+
* @memberof ShareTokenReadResponse
|
|
1248
|
+
*/
|
|
1249
|
+
'revoked': boolean;
|
|
1250
|
+
}
|
|
1251
|
+
/**
|
|
1252
|
+
*
|
|
1253
|
+
* @export
|
|
1254
|
+
* @enum {string}
|
|
1255
|
+
*/
|
|
1256
|
+
declare const SubjectType: {
|
|
1257
|
+
readonly User: "user";
|
|
1258
|
+
readonly OrganizationAdmin: "organization_admin";
|
|
1259
|
+
readonly OrganizationUser: "organization_user";
|
|
1260
|
+
readonly ShareToken: "share_token";
|
|
1261
|
+
};
|
|
1262
|
+
type SubjectType = typeof SubjectType[keyof typeof SubjectType];
|
|
1029
1263
|
/**
|
|
1030
1264
|
* Part of response schema for User object in `Get current user` endpoint. This model corresponds to the response schema returned from Auth0 GET /v2/users/{id} endpoint. For details, see: https://auth0.com/docs/api/management/v2/users/get-users-by-id
|
|
1031
1265
|
* @export
|
|
@@ -1243,6 +1477,14 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1243
1477
|
* @throws {RequiredError}
|
|
1244
1478
|
*/
|
|
1245
1479
|
cancelRunV1RunsRunIdCancelPost: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1480
|
+
/**
|
|
1481
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
1482
|
+
* @summary Create Grant
|
|
1483
|
+
* @param {GrantCreateRequest} grantCreateRequest
|
|
1484
|
+
* @param {*} [options] Override http request option.
|
|
1485
|
+
* @throws {RequiredError}
|
|
1486
|
+
*/
|
|
1487
|
+
createGrantV1AccessGrantsPost: (grantCreateRequest: GrantCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1246
1488
|
/**
|
|
1247
1489
|
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
1248
1490
|
* @summary Initiate Run
|
|
@@ -1251,6 +1493,14 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1251
1493
|
* @throws {RequiredError}
|
|
1252
1494
|
*/
|
|
1253
1495
|
createRunV1RunsPost: (runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1496
|
+
/**
|
|
1497
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
1498
|
+
* @summary Create Share Token
|
|
1499
|
+
* @param {ShareTokenCreateRequest} shareTokenCreateRequest
|
|
1500
|
+
* @param {*} [options] Override http request option.
|
|
1501
|
+
* @throws {RequiredError}
|
|
1502
|
+
*/
|
|
1503
|
+
createShareTokenV1AccessShareTokensPost: (shareTokenCreateRequest: ShareTokenCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1254
1504
|
/**
|
|
1255
1505
|
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
1256
1506
|
* @summary Delete Run Items
|
|
@@ -1264,19 +1514,29 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1264
1514
|
* @summary Get Artifact Url
|
|
1265
1515
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1266
1516
|
* @param {string} artifactId The artifact id to download
|
|
1517
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1267
1518
|
* @param {*} [options] Override http request option.
|
|
1268
1519
|
* @throws {RequiredError}
|
|
1269
1520
|
*/
|
|
1270
|
-
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: (runId: string, artifactId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1521
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: (runId: string, artifactId: string, shareToken?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1522
|
+
/**
|
|
1523
|
+
* Get a grant by its ID.
|
|
1524
|
+
* @summary Get Grant
|
|
1525
|
+
* @param {string} grantId Grant ID
|
|
1526
|
+
* @param {*} [options] Override http request option.
|
|
1527
|
+
* @throws {RequiredError}
|
|
1528
|
+
*/
|
|
1529
|
+
getGrantV1AccessGrantsGrantIdGet: (grantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1271
1530
|
/**
|
|
1272
1531
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1273
1532
|
* @summary Get Item By Run
|
|
1274
1533
|
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
1275
1534
|
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1535
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1276
1536
|
* @param {*} [options] Override http request option.
|
|
1277
1537
|
* @throws {RequiredError}
|
|
1278
1538
|
*/
|
|
1279
|
-
getItemByRunV1RunsRunIdItemsExternalIdGet: (runId: string, externalId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1539
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet: (runId: string, externalId: string, shareToken?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1280
1540
|
/**
|
|
1281
1541
|
* Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
|
|
1282
1542
|
* @summary Get current user
|
|
@@ -1285,13 +1545,22 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1285
1545
|
*/
|
|
1286
1546
|
getMeV1MeGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1287
1547
|
/**
|
|
1288
|
-
* 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.
|
|
1548
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
|
|
1289
1549
|
* @summary Get run details
|
|
1290
1550
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1551
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1291
1552
|
* @param {*} [options] Override http request option.
|
|
1292
1553
|
* @throws {RequiredError}
|
|
1293
1554
|
*/
|
|
1294
|
-
getRunV1RunsRunIdGet: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1555
|
+
getRunV1RunsRunIdGet: (runId: string, shareToken?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1556
|
+
/**
|
|
1557
|
+
* Get a share token by its ID.
|
|
1558
|
+
* @summary Get Share Token
|
|
1559
|
+
* @param {string} shareTokenId Share token ID
|
|
1560
|
+
* @param {*} [options] Override http request option.
|
|
1561
|
+
* @throws {RequiredError}
|
|
1562
|
+
*/
|
|
1563
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet: (shareTokenId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1295
1564
|
/**
|
|
1296
1565
|
* Return metadata for a single public document attached to an application version.
|
|
1297
1566
|
* @summary Get version document metadata
|
|
@@ -1332,10 +1601,27 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1332
1601
|
* @throws {RequiredError}
|
|
1333
1602
|
*/
|
|
1334
1603
|
listApplicationsV1ApplicationsGet: (page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1604
|
+
/**
|
|
1605
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
1606
|
+
* @summary List Grants
|
|
1607
|
+
* @param {ResourceType | null} [resourceType]
|
|
1608
|
+
* @param {string | null} [resourceId]
|
|
1609
|
+
* @param {SubjectType | null} [subjectType]
|
|
1610
|
+
* @param {string | null} [subjectId]
|
|
1611
|
+
* @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
|
|
1612
|
+
* @param {boolean | null} [revoked]
|
|
1613
|
+
* @param {number} [page]
|
|
1614
|
+
* @param {number} [pageSize]
|
|
1615
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1616
|
+
* @param {*} [options] Override http request option.
|
|
1617
|
+
* @throws {RequiredError}
|
|
1618
|
+
*/
|
|
1619
|
+
listGrantsV1AccessGrantsGet: (resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, relation?: Array<GrantRelation> | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1335
1620
|
/**
|
|
1336
1621
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1337
1622
|
* @summary List Run Items
|
|
1338
1623
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1624
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1339
1625
|
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
1340
1626
|
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
1341
1627
|
* @param {ItemState | null} [state] Filter items by their state
|
|
@@ -1347,7 +1633,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1347
1633
|
* @param {*} [options] Override http request option.
|
|
1348
1634
|
* @throws {RequiredError}
|
|
1349
1635
|
*/
|
|
1350
|
-
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>;
|
|
1636
|
+
listRunItemsV1RunsRunIdItemsGet: (runId: string, shareToken?: string | null, itemIdIn?: Array<string> | null, externalIdIn?: Array<string> | null, state?: ItemState | null, terminationReason?: ItemTerminationReason | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1351
1637
|
/**
|
|
1352
1638
|
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
1353
1639
|
* @summary List Runs
|
|
@@ -1357,12 +1643,27 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1357
1643
|
* @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: `$.study` - Runs that have a study field defined - **Exact value match**: `$.study ? (@ == \"high\")` - Runs with specific study value - **Numeric comparison**: `$.confidence_score ? (@ > 0.75)` - Runs with confidence score greater than 0.75 - **Array operations**: `$.tags[*] ? (@ == \"draft\")` - Runs with tags array containing \"draft\" - **Complex conditions**: `$.resources ? (@.gpu_count > 2 && @.memory_gb >= 16)` - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: `%24.study` - **Exact value match**: `%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)` - **Numeric comparison**: `%24.confidence_score%20%3F%20(%40%20%3E%200.75)` - **Array operations**: `%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)` - **Complex conditions**: `%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)` #### 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 - Regular expressions use `like_regex` with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
|
|
1358
1644
|
* @param {number} [page]
|
|
1359
1645
|
* @param {number} [pageSize]
|
|
1646
|
+
* @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
1647
|
+
* @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
1360
1648
|
* @param {string | null} [forOrganization] Filter runs by organization ID. Available for superadmins (any org) and admins (own org only). When provided, returns all runs for the specified organization instead of only the caller\'s own runs.
|
|
1361
1649
|
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `run_id` - `application_id` - `version_number` - `custom_metadata` - `submitted_at` - `submitted_by` - `terminated_at` - `termination_reason` **Examples:** - `?sort=submitted_at` - Sort by creation time (ascending) - `?sort=-submitted_at` - Sort by creation time (descending) - `?sort=state&sort=-submitted_at` - Sort by state, then by time (descending)
|
|
1362
1650
|
* @param {*} [options] Override http request option.
|
|
1363
1651
|
* @throws {RequiredError}
|
|
1364
1652
|
*/
|
|
1365
|
-
listRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1653
|
+
listRunsV1RunsGet: (applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, submittedBy?: string | null, organizationId?: string | null, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1654
|
+
/**
|
|
1655
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1656
|
+
* @summary List Share Tokens
|
|
1657
|
+
* @param {string | null} [runId] Filter by run ID
|
|
1658
|
+
* @param {string | null} [createdBy] Filter by share token creator
|
|
1659
|
+
* @param {boolean | null} [revoked]
|
|
1660
|
+
* @param {number} [page]
|
|
1661
|
+
* @param {number} [pageSize]
|
|
1662
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1663
|
+
* @param {*} [options] Override http request option.
|
|
1664
|
+
* @throws {RequiredError}
|
|
1665
|
+
*/
|
|
1666
|
+
listShareTokensV1AccessShareTokensGet: (runId?: string | null, createdBy?: string | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1366
1667
|
/**
|
|
1367
1668
|
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1368
1669
|
* @summary List version documents
|
|
@@ -1399,6 +1700,22 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1399
1700
|
* @throws {RequiredError}
|
|
1400
1701
|
*/
|
|
1401
1702
|
readApplicationByIdV1ApplicationsApplicationIdGet: (applicationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1703
|
+
/**
|
|
1704
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
1705
|
+
* @summary Revoke Grant
|
|
1706
|
+
* @param {string} grantId Grant ID
|
|
1707
|
+
* @param {*} [options] Override http request option.
|
|
1708
|
+
* @throws {RequiredError}
|
|
1709
|
+
*/
|
|
1710
|
+
revokeGrantV1AccessGrantsGrantIdDelete: (grantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1711
|
+
/**
|
|
1712
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1713
|
+
* @summary Revoke Share Token
|
|
1714
|
+
* @param {string} shareTokenId Share token ID
|
|
1715
|
+
* @param {*} [options] Override http request option.
|
|
1716
|
+
* @throws {RequiredError}
|
|
1717
|
+
*/
|
|
1718
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete: (shareTokenId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1402
1719
|
};
|
|
1403
1720
|
/**
|
|
1404
1721
|
* PublicApi - functional programming interface
|
|
@@ -1422,6 +1739,14 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1422
1739
|
* @throws {RequiredError}
|
|
1423
1740
|
*/
|
|
1424
1741
|
cancelRunV1RunsRunIdCancelPost(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1742
|
+
/**
|
|
1743
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
1744
|
+
* @summary Create Grant
|
|
1745
|
+
* @param {GrantCreateRequest} grantCreateRequest
|
|
1746
|
+
* @param {*} [options] Override http request option.
|
|
1747
|
+
* @throws {RequiredError}
|
|
1748
|
+
*/
|
|
1749
|
+
createGrantV1AccessGrantsPost(grantCreateRequest: GrantCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GrantReadResponse>>;
|
|
1425
1750
|
/**
|
|
1426
1751
|
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
1427
1752
|
* @summary Initiate Run
|
|
@@ -1430,6 +1755,14 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1430
1755
|
* @throws {RequiredError}
|
|
1431
1756
|
*/
|
|
1432
1757
|
createRunV1RunsPost(runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunCreationResponse>>;
|
|
1758
|
+
/**
|
|
1759
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
1760
|
+
* @summary Create Share Token
|
|
1761
|
+
* @param {ShareTokenCreateRequest} shareTokenCreateRequest
|
|
1762
|
+
* @param {*} [options] Override http request option.
|
|
1763
|
+
* @throws {RequiredError}
|
|
1764
|
+
*/
|
|
1765
|
+
createShareTokenV1AccessShareTokensPost(shareTokenCreateRequest: ShareTokenCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareTokenCreateResponse>>;
|
|
1433
1766
|
/**
|
|
1434
1767
|
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
1435
1768
|
* @summary Delete Run Items
|
|
@@ -1443,19 +1776,29 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1443
1776
|
* @summary Get Artifact Url
|
|
1444
1777
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1445
1778
|
* @param {string} artifactId The artifact id to download
|
|
1779
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1780
|
+
* @param {*} [options] Override http request option.
|
|
1781
|
+
* @throws {RequiredError}
|
|
1782
|
+
*/
|
|
1783
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId: string, artifactId: string, shareToken?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1784
|
+
/**
|
|
1785
|
+
* Get a grant by its ID.
|
|
1786
|
+
* @summary Get Grant
|
|
1787
|
+
* @param {string} grantId Grant ID
|
|
1446
1788
|
* @param {*} [options] Override http request option.
|
|
1447
1789
|
* @throws {RequiredError}
|
|
1448
1790
|
*/
|
|
1449
|
-
|
|
1791
|
+
getGrantV1AccessGrantsGrantIdGet(grantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GrantReadResponse>>;
|
|
1450
1792
|
/**
|
|
1451
1793
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1452
1794
|
* @summary Get Item By Run
|
|
1453
1795
|
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
1454
1796
|
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1797
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1455
1798
|
* @param {*} [options] Override http request option.
|
|
1456
1799
|
* @throws {RequiredError}
|
|
1457
1800
|
*/
|
|
1458
|
-
getItemByRunV1RunsRunIdItemsExternalIdGet(runId: string, externalId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemResultReadResponse>>;
|
|
1801
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet(runId: string, externalId: string, shareToken?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemResultReadResponse>>;
|
|
1459
1802
|
/**
|
|
1460
1803
|
* Retrieves your identity details, including name, email, and organization. This is useful for verifying that the request is being made under the correct user profile and organization context, as well as confirming that the expected environment variables are correctly set (in case you are using Python SDK)
|
|
1461
1804
|
* @summary Get current user
|
|
@@ -1464,13 +1807,22 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1464
1807
|
*/
|
|
1465
1808
|
getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeReadResponse>>;
|
|
1466
1809
|
/**
|
|
1467
|
-
* 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.
|
|
1810
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
|
|
1468
1811
|
* @summary Get run details
|
|
1469
1812
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1813
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1470
1814
|
* @param {*} [options] Override http request option.
|
|
1471
1815
|
* @throws {RequiredError}
|
|
1472
1816
|
*/
|
|
1473
|
-
getRunV1RunsRunIdGet(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunReadResponse>>;
|
|
1817
|
+
getRunV1RunsRunIdGet(runId: string, shareToken?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunReadResponse>>;
|
|
1818
|
+
/**
|
|
1819
|
+
* Get a share token by its ID.
|
|
1820
|
+
* @summary Get Share Token
|
|
1821
|
+
* @param {string} shareTokenId Share token ID
|
|
1822
|
+
* @param {*} [options] Override http request option.
|
|
1823
|
+
* @throws {RequiredError}
|
|
1824
|
+
*/
|
|
1825
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(shareTokenId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareTokenReadResponse>>;
|
|
1474
1826
|
/**
|
|
1475
1827
|
* Return metadata for a single public document attached to an application version.
|
|
1476
1828
|
* @summary Get version document metadata
|
|
@@ -1511,10 +1863,27 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1511
1863
|
* @throws {RequiredError}
|
|
1512
1864
|
*/
|
|
1513
1865
|
listApplicationsV1ApplicationsGet(page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicationReadShortResponse>>>;
|
|
1866
|
+
/**
|
|
1867
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
1868
|
+
* @summary List Grants
|
|
1869
|
+
* @param {ResourceType | null} [resourceType]
|
|
1870
|
+
* @param {string | null} [resourceId]
|
|
1871
|
+
* @param {SubjectType | null} [subjectType]
|
|
1872
|
+
* @param {string | null} [subjectId]
|
|
1873
|
+
* @param {Array<GrantRelation> | null} [relation] Filter grants by relation type. Can be specified multiple times.
|
|
1874
|
+
* @param {boolean | null} [revoked]
|
|
1875
|
+
* @param {number} [page]
|
|
1876
|
+
* @param {number} [pageSize]
|
|
1877
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1878
|
+
* @param {*} [options] Override http request option.
|
|
1879
|
+
* @throws {RequiredError}
|
|
1880
|
+
*/
|
|
1881
|
+
listGrantsV1AccessGrantsGet(resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, relation?: Array<GrantRelation> | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GrantReadResponse>>>;
|
|
1514
1882
|
/**
|
|
1515
1883
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1516
1884
|
* @summary List Run Items
|
|
1517
1885
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1886
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1518
1887
|
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
1519
1888
|
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
1520
1889
|
* @param {ItemState | null} [state] Filter items by their state
|
|
@@ -1526,7 +1895,7 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1526
1895
|
* @param {*} [options] Override http request option.
|
|
1527
1896
|
* @throws {RequiredError}
|
|
1528
1897
|
*/
|
|
1529
|
-
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>>>;
|
|
1898
|
+
listRunItemsV1RunsRunIdItemsGet(runId: string, shareToken?: string | null, itemIdIn?: Array<string> | null, externalIdIn?: Array<string> | null, state?: ItemState | null, terminationReason?: ItemTerminationReason | null, customMetadata?: string | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ItemResultReadResponse>>>;
|
|
1530
1899
|
/**
|
|
1531
1900
|
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
1532
1901
|
* @summary List Runs
|
|
@@ -1536,12 +1905,27 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1536
1905
|
* @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: `$.study` - Runs that have a study field defined - **Exact value match**: `$.study ? (@ == \"high\")` - Runs with specific study value - **Numeric comparison**: `$.confidence_score ? (@ > 0.75)` - Runs with confidence score greater than 0.75 - **Array operations**: `$.tags[*] ? (@ == \"draft\")` - Runs with tags array containing \"draft\" - **Complex conditions**: `$.resources ? (@.gpu_count > 2 && @.memory_gb >= 16)` - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: `%24.study` - **Exact value match**: `%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)` - **Numeric comparison**: `%24.confidence_score%20%3F%20(%40%20%3E%200.75)` - **Array operations**: `%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)` - **Complex conditions**: `%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)` #### 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 - Regular expressions use `like_regex` with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
|
|
1537
1906
|
* @param {number} [page]
|
|
1538
1907
|
* @param {number} [pageSize]
|
|
1908
|
+
* @param {string | null} [submittedBy] Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
1909
|
+
* @param {string | null} [organizationId] Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
1539
1910
|
* @param {string | null} [forOrganization] Filter runs by organization ID. Available for superadmins (any org) and admins (own org only). When provided, returns all runs for the specified organization instead of only the caller\'s own runs.
|
|
1540
1911
|
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order. **Available fields:** - `run_id` - `application_id` - `version_number` - `custom_metadata` - `submitted_at` - `submitted_by` - `terminated_at` - `termination_reason` **Examples:** - `?sort=submitted_at` - Sort by creation time (ascending) - `?sort=-submitted_at` - Sort by creation time (descending) - `?sort=state&sort=-submitted_at` - Sort by state, then by time (descending)
|
|
1541
1912
|
* @param {*} [options] Override http request option.
|
|
1542
1913
|
* @throws {RequiredError}
|
|
1543
1914
|
*/
|
|
1544
|
-
listRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
|
|
1915
|
+
listRunsV1RunsGet(applicationId?: string | null, applicationVersion?: string | null, externalId?: string | null, customMetadata?: string | null, page?: number, pageSize?: number, submittedBy?: string | null, organizationId?: string | null, forOrganization?: string | null, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunReadResponse>>>;
|
|
1916
|
+
/**
|
|
1917
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1918
|
+
* @summary List Share Tokens
|
|
1919
|
+
* @param {string | null} [runId] Filter by run ID
|
|
1920
|
+
* @param {string | null} [createdBy] Filter by share token creator
|
|
1921
|
+
* @param {boolean | null} [revoked]
|
|
1922
|
+
* @param {number} [page]
|
|
1923
|
+
* @param {number} [pageSize]
|
|
1924
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1925
|
+
* @param {*} [options] Override http request option.
|
|
1926
|
+
* @throws {RequiredError}
|
|
1927
|
+
*/
|
|
1928
|
+
listShareTokensV1AccessShareTokensGet(runId?: string | null, createdBy?: string | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ShareTokenReadResponse>>>;
|
|
1545
1929
|
/**
|
|
1546
1930
|
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1547
1931
|
* @summary List version documents
|
|
@@ -1578,6 +1962,22 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1578
1962
|
* @throws {RequiredError}
|
|
1579
1963
|
*/
|
|
1580
1964
|
readApplicationByIdV1ApplicationsApplicationIdGet(applicationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationReadResponse>>;
|
|
1965
|
+
/**
|
|
1966
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
1967
|
+
* @summary Revoke Grant
|
|
1968
|
+
* @param {string} grantId Grant ID
|
|
1969
|
+
* @param {*} [options] Override http request option.
|
|
1970
|
+
* @throws {RequiredError}
|
|
1971
|
+
*/
|
|
1972
|
+
revokeGrantV1AccessGrantsGrantIdDelete(grantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GrantReadResponse>>;
|
|
1973
|
+
/**
|
|
1974
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1975
|
+
* @summary Revoke Share Token
|
|
1976
|
+
* @param {string} shareTokenId Share token ID
|
|
1977
|
+
* @param {*} [options] Override http request option.
|
|
1978
|
+
* @throws {RequiredError}
|
|
1979
|
+
*/
|
|
1980
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(shareTokenId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareTokenReadResponse>>;
|
|
1581
1981
|
};
|
|
1582
1982
|
/**
|
|
1583
1983
|
* PublicApi - factory interface
|
|
@@ -1600,6 +2000,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1600
2000
|
* @throws {RequiredError}
|
|
1601
2001
|
*/
|
|
1602
2002
|
cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
2003
|
+
/**
|
|
2004
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
2005
|
+
* @summary Create Grant
|
|
2006
|
+
* @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
|
|
2007
|
+
* @param {*} [options] Override http request option.
|
|
2008
|
+
* @throws {RequiredError}
|
|
2009
|
+
*/
|
|
2010
|
+
createGrantV1AccessGrantsPost(requestParameters: PublicApiCreateGrantV1AccessGrantsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
1603
2011
|
/**
|
|
1604
2012
|
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
1605
2013
|
* @summary Initiate Run
|
|
@@ -1608,6 +2016,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1608
2016
|
* @throws {RequiredError}
|
|
1609
2017
|
*/
|
|
1610
2018
|
createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
|
|
2019
|
+
/**
|
|
2020
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
2021
|
+
* @summary Create Share Token
|
|
2022
|
+
* @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
|
|
2023
|
+
* @param {*} [options] Override http request option.
|
|
2024
|
+
* @throws {RequiredError}
|
|
2025
|
+
*/
|
|
2026
|
+
createShareTokenV1AccessShareTokensPost(requestParameters: PublicApiCreateShareTokenV1AccessShareTokensPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenCreateResponse>;
|
|
1611
2027
|
/**
|
|
1612
2028
|
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
1613
2029
|
* @summary Delete Run Items
|
|
@@ -1624,6 +2040,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1624
2040
|
* @throws {RequiredError}
|
|
1625
2041
|
*/
|
|
1626
2042
|
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
2043
|
+
/**
|
|
2044
|
+
* Get a grant by its ID.
|
|
2045
|
+
* @summary Get Grant
|
|
2046
|
+
* @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
|
|
2047
|
+
* @param {*} [options] Override http request option.
|
|
2048
|
+
* @throws {RequiredError}
|
|
2049
|
+
*/
|
|
2050
|
+
getGrantV1AccessGrantsGrantIdGet(requestParameters: PublicApiGetGrantV1AccessGrantsGrantIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
1627
2051
|
/**
|
|
1628
2052
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1629
2053
|
* @summary Get Item By Run
|
|
@@ -1640,13 +2064,21 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1640
2064
|
*/
|
|
1641
2065
|
getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
|
|
1642
2066
|
/**
|
|
1643
|
-
* 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.
|
|
2067
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
|
|
1644
2068
|
* @summary Get run details
|
|
1645
2069
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
1646
2070
|
* @param {*} [options] Override http request option.
|
|
1647
2071
|
* @throws {RequiredError}
|
|
1648
2072
|
*/
|
|
1649
2073
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
|
|
2074
|
+
/**
|
|
2075
|
+
* Get a share token by its ID.
|
|
2076
|
+
* @summary Get Share Token
|
|
2077
|
+
* @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
|
|
2078
|
+
* @param {*} [options] Override http request option.
|
|
2079
|
+
* @throws {RequiredError}
|
|
2080
|
+
*/
|
|
2081
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters: PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
|
|
1650
2082
|
/**
|
|
1651
2083
|
* Return metadata for a single public document attached to an application version.
|
|
1652
2084
|
* @summary Get version document metadata
|
|
@@ -1679,6 +2111,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1679
2111
|
* @throws {RequiredError}
|
|
1680
2112
|
*/
|
|
1681
2113
|
listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
|
|
2114
|
+
/**
|
|
2115
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
2116
|
+
* @summary List Grants
|
|
2117
|
+
* @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
|
|
2118
|
+
* @param {*} [options] Override http request option.
|
|
2119
|
+
* @throws {RequiredError}
|
|
2120
|
+
*/
|
|
2121
|
+
listGrantsV1AccessGrantsGet(requestParameters?: PublicApiListGrantsV1AccessGrantsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<GrantReadResponse>>;
|
|
1682
2122
|
/**
|
|
1683
2123
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1684
2124
|
* @summary List Run Items
|
|
@@ -1695,6 +2135,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1695
2135
|
* @throws {RequiredError}
|
|
1696
2136
|
*/
|
|
1697
2137
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
|
|
2138
|
+
/**
|
|
2139
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
2140
|
+
* @summary List Share Tokens
|
|
2141
|
+
* @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
|
|
2142
|
+
* @param {*} [options] Override http request option.
|
|
2143
|
+
* @throws {RequiredError}
|
|
2144
|
+
*/
|
|
2145
|
+
listShareTokensV1AccessShareTokensGet(requestParameters?: PublicApiListShareTokensV1AccessShareTokensGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ShareTokenReadResponse>>;
|
|
1698
2146
|
/**
|
|
1699
2147
|
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1700
2148
|
* @summary List version documents
|
|
@@ -1727,6 +2175,22 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1727
2175
|
* @throws {RequiredError}
|
|
1728
2176
|
*/
|
|
1729
2177
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationReadResponse>;
|
|
2178
|
+
/**
|
|
2179
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
2180
|
+
* @summary Revoke Grant
|
|
2181
|
+
* @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
|
|
2182
|
+
* @param {*} [options] Override http request option.
|
|
2183
|
+
* @throws {RequiredError}
|
|
2184
|
+
*/
|
|
2185
|
+
revokeGrantV1AccessGrantsGrantIdDelete(requestParameters: PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
2186
|
+
/**
|
|
2187
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
2188
|
+
* @summary Revoke Share Token
|
|
2189
|
+
* @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
|
|
2190
|
+
* @param {*} [options] Override http request option.
|
|
2191
|
+
* @throws {RequiredError}
|
|
2192
|
+
*/
|
|
2193
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters: PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
|
|
1730
2194
|
};
|
|
1731
2195
|
/**
|
|
1732
2196
|
* PublicApi - interface
|
|
@@ -1752,6 +2216,15 @@ interface PublicApiInterface {
|
|
|
1752
2216
|
* @memberof PublicApiInterface
|
|
1753
2217
|
*/
|
|
1754
2218
|
cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
2219
|
+
/**
|
|
2220
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
2221
|
+
* @summary Create Grant
|
|
2222
|
+
* @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
|
|
2223
|
+
* @param {*} [options] Override http request option.
|
|
2224
|
+
* @throws {RequiredError}
|
|
2225
|
+
* @memberof PublicApiInterface
|
|
2226
|
+
*/
|
|
2227
|
+
createGrantV1AccessGrantsPost(requestParameters: PublicApiCreateGrantV1AccessGrantsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
1755
2228
|
/**
|
|
1756
2229
|
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
1757
2230
|
* @summary Initiate Run
|
|
@@ -1761,6 +2234,15 @@ interface PublicApiInterface {
|
|
|
1761
2234
|
* @memberof PublicApiInterface
|
|
1762
2235
|
*/
|
|
1763
2236
|
createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
|
|
2237
|
+
/**
|
|
2238
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
2239
|
+
* @summary Create Share Token
|
|
2240
|
+
* @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
|
|
2241
|
+
* @param {*} [options] Override http request option.
|
|
2242
|
+
* @throws {RequiredError}
|
|
2243
|
+
* @memberof PublicApiInterface
|
|
2244
|
+
*/
|
|
2245
|
+
createShareTokenV1AccessShareTokensPost(requestParameters: PublicApiCreateShareTokenV1AccessShareTokensPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenCreateResponse>;
|
|
1764
2246
|
/**
|
|
1765
2247
|
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
1766
2248
|
* @summary Delete Run Items
|
|
@@ -1779,6 +2261,15 @@ interface PublicApiInterface {
|
|
|
1779
2261
|
* @memberof PublicApiInterface
|
|
1780
2262
|
*/
|
|
1781
2263
|
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
2264
|
+
/**
|
|
2265
|
+
* Get a grant by its ID.
|
|
2266
|
+
* @summary Get Grant
|
|
2267
|
+
* @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
|
|
2268
|
+
* @param {*} [options] Override http request option.
|
|
2269
|
+
* @throws {RequiredError}
|
|
2270
|
+
* @memberof PublicApiInterface
|
|
2271
|
+
*/
|
|
2272
|
+
getGrantV1AccessGrantsGrantIdGet(requestParameters: PublicApiGetGrantV1AccessGrantsGrantIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
1782
2273
|
/**
|
|
1783
2274
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1784
2275
|
* @summary Get Item By Run
|
|
@@ -1797,7 +2288,7 @@ interface PublicApiInterface {
|
|
|
1797
2288
|
*/
|
|
1798
2289
|
getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
|
|
1799
2290
|
/**
|
|
1800
|
-
* 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.
|
|
2291
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
|
|
1801
2292
|
* @summary Get run details
|
|
1802
2293
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
1803
2294
|
* @param {*} [options] Override http request option.
|
|
@@ -1805,6 +2296,15 @@ interface PublicApiInterface {
|
|
|
1805
2296
|
* @memberof PublicApiInterface
|
|
1806
2297
|
*/
|
|
1807
2298
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
|
|
2299
|
+
/**
|
|
2300
|
+
* Get a share token by its ID.
|
|
2301
|
+
* @summary Get Share Token
|
|
2302
|
+
* @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
|
|
2303
|
+
* @param {*} [options] Override http request option.
|
|
2304
|
+
* @throws {RequiredError}
|
|
2305
|
+
* @memberof PublicApiInterface
|
|
2306
|
+
*/
|
|
2307
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters: PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
|
|
1808
2308
|
/**
|
|
1809
2309
|
* Return metadata for a single public document attached to an application version.
|
|
1810
2310
|
* @summary Get version document metadata
|
|
@@ -1841,6 +2341,15 @@ interface PublicApiInterface {
|
|
|
1841
2341
|
* @memberof PublicApiInterface
|
|
1842
2342
|
*/
|
|
1843
2343
|
listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
|
|
2344
|
+
/**
|
|
2345
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
2346
|
+
* @summary List Grants
|
|
2347
|
+
* @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
|
|
2348
|
+
* @param {*} [options] Override http request option.
|
|
2349
|
+
* @throws {RequiredError}
|
|
2350
|
+
* @memberof PublicApiInterface
|
|
2351
|
+
*/
|
|
2352
|
+
listGrantsV1AccessGrantsGet(requestParameters?: PublicApiListGrantsV1AccessGrantsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<GrantReadResponse>>;
|
|
1844
2353
|
/**
|
|
1845
2354
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
1846
2355
|
* @summary List Run Items
|
|
@@ -1859,6 +2368,15 @@ interface PublicApiInterface {
|
|
|
1859
2368
|
* @memberof PublicApiInterface
|
|
1860
2369
|
*/
|
|
1861
2370
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
|
|
2371
|
+
/**
|
|
2372
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
2373
|
+
* @summary List Share Tokens
|
|
2374
|
+
* @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
|
|
2375
|
+
* @param {*} [options] Override http request option.
|
|
2376
|
+
* @throws {RequiredError}
|
|
2377
|
+
* @memberof PublicApiInterface
|
|
2378
|
+
*/
|
|
2379
|
+
listShareTokensV1AccessShareTokensGet(requestParameters?: PublicApiListShareTokensV1AccessShareTokensGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ShareTokenReadResponse>>;
|
|
1862
2380
|
/**
|
|
1863
2381
|
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1864
2382
|
* @summary List version documents
|
|
@@ -1895,6 +2413,24 @@ interface PublicApiInterface {
|
|
|
1895
2413
|
* @memberof PublicApiInterface
|
|
1896
2414
|
*/
|
|
1897
2415
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationReadResponse>;
|
|
2416
|
+
/**
|
|
2417
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
2418
|
+
* @summary Revoke Grant
|
|
2419
|
+
* @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
|
|
2420
|
+
* @param {*} [options] Override http request option.
|
|
2421
|
+
* @throws {RequiredError}
|
|
2422
|
+
* @memberof PublicApiInterface
|
|
2423
|
+
*/
|
|
2424
|
+
revokeGrantV1AccessGrantsGrantIdDelete(requestParameters: PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
2425
|
+
/**
|
|
2426
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
2427
|
+
* @summary Revoke Share Token
|
|
2428
|
+
* @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
|
|
2429
|
+
* @param {*} [options] Override http request option.
|
|
2430
|
+
* @throws {RequiredError}
|
|
2431
|
+
* @memberof PublicApiInterface
|
|
2432
|
+
*/
|
|
2433
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters: PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
|
|
1898
2434
|
}
|
|
1899
2435
|
/**
|
|
1900
2436
|
* Request parameters for applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet operation in PublicApi.
|
|
@@ -1928,6 +2464,19 @@ interface PublicApiCancelRunV1RunsRunIdCancelPostRequest {
|
|
|
1928
2464
|
*/
|
|
1929
2465
|
readonly runId: string;
|
|
1930
2466
|
}
|
|
2467
|
+
/**
|
|
2468
|
+
* Request parameters for createGrantV1AccessGrantsPost operation in PublicApi.
|
|
2469
|
+
* @export
|
|
2470
|
+
* @interface PublicApiCreateGrantV1AccessGrantsPostRequest
|
|
2471
|
+
*/
|
|
2472
|
+
interface PublicApiCreateGrantV1AccessGrantsPostRequest {
|
|
2473
|
+
/**
|
|
2474
|
+
*
|
|
2475
|
+
* @type {GrantCreateRequest}
|
|
2476
|
+
* @memberof PublicApiCreateGrantV1AccessGrantsPost
|
|
2477
|
+
*/
|
|
2478
|
+
readonly grantCreateRequest: GrantCreateRequest;
|
|
2479
|
+
}
|
|
1931
2480
|
/**
|
|
1932
2481
|
* Request parameters for createRunV1RunsPost operation in PublicApi.
|
|
1933
2482
|
* @export
|
|
@@ -1941,6 +2490,19 @@ interface PublicApiCreateRunV1RunsPostRequest {
|
|
|
1941
2490
|
*/
|
|
1942
2491
|
readonly runCreationRequest: RunCreationRequest;
|
|
1943
2492
|
}
|
|
2493
|
+
/**
|
|
2494
|
+
* Request parameters for createShareTokenV1AccessShareTokensPost operation in PublicApi.
|
|
2495
|
+
* @export
|
|
2496
|
+
* @interface PublicApiCreateShareTokenV1AccessShareTokensPostRequest
|
|
2497
|
+
*/
|
|
2498
|
+
interface PublicApiCreateShareTokenV1AccessShareTokensPostRequest {
|
|
2499
|
+
/**
|
|
2500
|
+
*
|
|
2501
|
+
* @type {ShareTokenCreateRequest}
|
|
2502
|
+
* @memberof PublicApiCreateShareTokenV1AccessShareTokensPost
|
|
2503
|
+
*/
|
|
2504
|
+
readonly shareTokenCreateRequest: ShareTokenCreateRequest;
|
|
2505
|
+
}
|
|
1944
2506
|
/**
|
|
1945
2507
|
* Request parameters for deleteRunItemsV1RunsRunIdArtifactsDelete operation in PublicApi.
|
|
1946
2508
|
* @export
|
|
@@ -1972,6 +2534,25 @@ interface PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest {
|
|
|
1972
2534
|
* @memberof PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet
|
|
1973
2535
|
*/
|
|
1974
2536
|
readonly artifactId: string;
|
|
2537
|
+
/**
|
|
2538
|
+
* Share token for accessing shared runs
|
|
2539
|
+
* @type {string}
|
|
2540
|
+
* @memberof PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet
|
|
2541
|
+
*/
|
|
2542
|
+
readonly shareToken?: string | null;
|
|
2543
|
+
}
|
|
2544
|
+
/**
|
|
2545
|
+
* Request parameters for getGrantV1AccessGrantsGrantIdGet operation in PublicApi.
|
|
2546
|
+
* @export
|
|
2547
|
+
* @interface PublicApiGetGrantV1AccessGrantsGrantIdGetRequest
|
|
2548
|
+
*/
|
|
2549
|
+
interface PublicApiGetGrantV1AccessGrantsGrantIdGetRequest {
|
|
2550
|
+
/**
|
|
2551
|
+
* Grant ID
|
|
2552
|
+
* @type {string}
|
|
2553
|
+
* @memberof PublicApiGetGrantV1AccessGrantsGrantIdGet
|
|
2554
|
+
*/
|
|
2555
|
+
readonly grantId: string;
|
|
1975
2556
|
}
|
|
1976
2557
|
/**
|
|
1977
2558
|
* Request parameters for getItemByRunV1RunsRunIdItemsExternalIdGet operation in PublicApi.
|
|
@@ -1991,6 +2572,12 @@ interface PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest {
|
|
|
1991
2572
|
* @memberof PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGet
|
|
1992
2573
|
*/
|
|
1993
2574
|
readonly externalId: string;
|
|
2575
|
+
/**
|
|
2576
|
+
* Share token for accessing shared runs
|
|
2577
|
+
* @type {string}
|
|
2578
|
+
* @memberof PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGet
|
|
2579
|
+
*/
|
|
2580
|
+
readonly shareToken?: string | null;
|
|
1994
2581
|
}
|
|
1995
2582
|
/**
|
|
1996
2583
|
* Request parameters for getRunV1RunsRunIdGet operation in PublicApi.
|
|
@@ -2004,6 +2591,25 @@ interface PublicApiGetRunV1RunsRunIdGetRequest {
|
|
|
2004
2591
|
* @memberof PublicApiGetRunV1RunsRunIdGet
|
|
2005
2592
|
*/
|
|
2006
2593
|
readonly runId: string;
|
|
2594
|
+
/**
|
|
2595
|
+
* Share token for accessing shared runs
|
|
2596
|
+
* @type {string}
|
|
2597
|
+
* @memberof PublicApiGetRunV1RunsRunIdGet
|
|
2598
|
+
*/
|
|
2599
|
+
readonly shareToken?: string | null;
|
|
2600
|
+
}
|
|
2601
|
+
/**
|
|
2602
|
+
* Request parameters for getShareTokenV1AccessShareTokensShareTokenIdGet operation in PublicApi.
|
|
2603
|
+
* @export
|
|
2604
|
+
* @interface PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest
|
|
2605
|
+
*/
|
|
2606
|
+
interface PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest {
|
|
2607
|
+
/**
|
|
2608
|
+
* Share token ID
|
|
2609
|
+
* @type {string}
|
|
2610
|
+
* @memberof PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGet
|
|
2611
|
+
*/
|
|
2612
|
+
readonly shareTokenId: string;
|
|
2007
2613
|
}
|
|
2008
2614
|
/**
|
|
2009
2615
|
* Request parameters for getVersionDocument operation in PublicApi.
|
|
@@ -2105,6 +2711,67 @@ interface PublicApiListApplicationsV1ApplicationsGetRequest {
|
|
|
2105
2711
|
*/
|
|
2106
2712
|
readonly sort?: Array<string> | null;
|
|
2107
2713
|
}
|
|
2714
|
+
/**
|
|
2715
|
+
* Request parameters for listGrantsV1AccessGrantsGet operation in PublicApi.
|
|
2716
|
+
* @export
|
|
2717
|
+
* @interface PublicApiListGrantsV1AccessGrantsGetRequest
|
|
2718
|
+
*/
|
|
2719
|
+
interface PublicApiListGrantsV1AccessGrantsGetRequest {
|
|
2720
|
+
/**
|
|
2721
|
+
*
|
|
2722
|
+
* @type {ResourceType}
|
|
2723
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2724
|
+
*/
|
|
2725
|
+
readonly resourceType?: ResourceType | null;
|
|
2726
|
+
/**
|
|
2727
|
+
*
|
|
2728
|
+
* @type {string}
|
|
2729
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2730
|
+
*/
|
|
2731
|
+
readonly resourceId?: string | null;
|
|
2732
|
+
/**
|
|
2733
|
+
*
|
|
2734
|
+
* @type {SubjectType}
|
|
2735
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2736
|
+
*/
|
|
2737
|
+
readonly subjectType?: SubjectType | null;
|
|
2738
|
+
/**
|
|
2739
|
+
*
|
|
2740
|
+
* @type {string}
|
|
2741
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2742
|
+
*/
|
|
2743
|
+
readonly subjectId?: string | null;
|
|
2744
|
+
/**
|
|
2745
|
+
* Filter grants by relation type. Can be specified multiple times.
|
|
2746
|
+
* @type {Array<GrantRelation>}
|
|
2747
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2748
|
+
*/
|
|
2749
|
+
readonly relation?: Array<GrantRelation> | null;
|
|
2750
|
+
/**
|
|
2751
|
+
*
|
|
2752
|
+
* @type {boolean}
|
|
2753
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2754
|
+
*/
|
|
2755
|
+
readonly revoked?: boolean | null;
|
|
2756
|
+
/**
|
|
2757
|
+
*
|
|
2758
|
+
* @type {number}
|
|
2759
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2760
|
+
*/
|
|
2761
|
+
readonly page?: number;
|
|
2762
|
+
/**
|
|
2763
|
+
*
|
|
2764
|
+
* @type {number}
|
|
2765
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2766
|
+
*/
|
|
2767
|
+
readonly pageSize?: number;
|
|
2768
|
+
/**
|
|
2769
|
+
* Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
2770
|
+
* @type {Array<string>}
|
|
2771
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2772
|
+
*/
|
|
2773
|
+
readonly sort?: Array<string> | null;
|
|
2774
|
+
}
|
|
2108
2775
|
/**
|
|
2109
2776
|
* Request parameters for listRunItemsV1RunsRunIdItemsGet operation in PublicApi.
|
|
2110
2777
|
* @export
|
|
@@ -2117,6 +2784,12 @@ interface PublicApiListRunItemsV1RunsRunIdItemsGetRequest {
|
|
|
2117
2784
|
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
2118
2785
|
*/
|
|
2119
2786
|
readonly runId: string;
|
|
2787
|
+
/**
|
|
2788
|
+
* Share token for accessing shared runs
|
|
2789
|
+
* @type {string}
|
|
2790
|
+
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
2791
|
+
*/
|
|
2792
|
+
readonly shareToken?: string | null;
|
|
2120
2793
|
/**
|
|
2121
2794
|
* Filter for item ids
|
|
2122
2795
|
* @type {Array<string>}
|
|
@@ -2208,6 +2881,18 @@ interface PublicApiListRunsV1RunsGetRequest {
|
|
|
2208
2881
|
* @memberof PublicApiListRunsV1RunsGet
|
|
2209
2882
|
*/
|
|
2210
2883
|
readonly pageSize?: number;
|
|
2884
|
+
/**
|
|
2885
|
+
* Filter runs by the user who submitted them. Use the special value `me` to return only runs submitted by the current user.
|
|
2886
|
+
* @type {string}
|
|
2887
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
2888
|
+
*/
|
|
2889
|
+
readonly submittedBy?: string | null;
|
|
2890
|
+
/**
|
|
2891
|
+
* Filter runs by the organization of the submitter. Use the special value `my_org` to filter by the current user\'s organization.
|
|
2892
|
+
* @type {string}
|
|
2893
|
+
* @memberof PublicApiListRunsV1RunsGet
|
|
2894
|
+
*/
|
|
2895
|
+
readonly organizationId?: string | null;
|
|
2211
2896
|
/**
|
|
2212
2897
|
* Filter runs by organization ID. Available for superadmins (any org) and admins (own org only). When provided, returns all runs for the specified organization instead of only the caller\'s own runs.
|
|
2213
2898
|
* @type {string}
|
|
@@ -2221,6 +2906,49 @@ interface PublicApiListRunsV1RunsGetRequest {
|
|
|
2221
2906
|
*/
|
|
2222
2907
|
readonly sort?: Array<string> | null;
|
|
2223
2908
|
}
|
|
2909
|
+
/**
|
|
2910
|
+
* Request parameters for listShareTokensV1AccessShareTokensGet operation in PublicApi.
|
|
2911
|
+
* @export
|
|
2912
|
+
* @interface PublicApiListShareTokensV1AccessShareTokensGetRequest
|
|
2913
|
+
*/
|
|
2914
|
+
interface PublicApiListShareTokensV1AccessShareTokensGetRequest {
|
|
2915
|
+
/**
|
|
2916
|
+
* Filter by run ID
|
|
2917
|
+
* @type {string}
|
|
2918
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2919
|
+
*/
|
|
2920
|
+
readonly runId?: string | null;
|
|
2921
|
+
/**
|
|
2922
|
+
* Filter by share token creator
|
|
2923
|
+
* @type {string}
|
|
2924
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2925
|
+
*/
|
|
2926
|
+
readonly createdBy?: string | null;
|
|
2927
|
+
/**
|
|
2928
|
+
*
|
|
2929
|
+
* @type {boolean}
|
|
2930
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2931
|
+
*/
|
|
2932
|
+
readonly revoked?: boolean | null;
|
|
2933
|
+
/**
|
|
2934
|
+
*
|
|
2935
|
+
* @type {number}
|
|
2936
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2937
|
+
*/
|
|
2938
|
+
readonly page?: number;
|
|
2939
|
+
/**
|
|
2940
|
+
*
|
|
2941
|
+
* @type {number}
|
|
2942
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2943
|
+
*/
|
|
2944
|
+
readonly pageSize?: number;
|
|
2945
|
+
/**
|
|
2946
|
+
* Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
2947
|
+
* @type {Array<string>}
|
|
2948
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2949
|
+
*/
|
|
2950
|
+
readonly sort?: Array<string> | null;
|
|
2951
|
+
}
|
|
2224
2952
|
/**
|
|
2225
2953
|
* Request parameters for listVersionDocuments operation in PublicApi.
|
|
2226
2954
|
* @export
|
|
@@ -2297,6 +3025,32 @@ interface PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest {
|
|
|
2297
3025
|
*/
|
|
2298
3026
|
readonly applicationId: string;
|
|
2299
3027
|
}
|
|
3028
|
+
/**
|
|
3029
|
+
* Request parameters for revokeGrantV1AccessGrantsGrantIdDelete operation in PublicApi.
|
|
3030
|
+
* @export
|
|
3031
|
+
* @interface PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest
|
|
3032
|
+
*/
|
|
3033
|
+
interface PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest {
|
|
3034
|
+
/**
|
|
3035
|
+
* Grant ID
|
|
3036
|
+
* @type {string}
|
|
3037
|
+
* @memberof PublicApiRevokeGrantV1AccessGrantsGrantIdDelete
|
|
3038
|
+
*/
|
|
3039
|
+
readonly grantId: string;
|
|
3040
|
+
}
|
|
3041
|
+
/**
|
|
3042
|
+
* Request parameters for revokeShareTokenV1AccessShareTokensShareTokenIdDelete operation in PublicApi.
|
|
3043
|
+
* @export
|
|
3044
|
+
* @interface PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest
|
|
3045
|
+
*/
|
|
3046
|
+
interface PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest {
|
|
3047
|
+
/**
|
|
3048
|
+
* Share token ID
|
|
3049
|
+
* @type {string}
|
|
3050
|
+
* @memberof PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDelete
|
|
3051
|
+
*/
|
|
3052
|
+
readonly shareTokenId: string;
|
|
3053
|
+
}
|
|
2300
3054
|
/**
|
|
2301
3055
|
* PublicApi - object-oriented interface
|
|
2302
3056
|
* @export
|
|
@@ -2322,6 +3076,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2322
3076
|
* @memberof PublicApi
|
|
2323
3077
|
*/
|
|
2324
3078
|
cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
3079
|
+
/**
|
|
3080
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
3081
|
+
* @summary Create Grant
|
|
3082
|
+
* @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
|
|
3083
|
+
* @param {*} [options] Override http request option.
|
|
3084
|
+
* @throws {RequiredError}
|
|
3085
|
+
* @memberof PublicApi
|
|
3086
|
+
*/
|
|
3087
|
+
createGrantV1AccessGrantsPost(requestParameters: PublicApiCreateGrantV1AccessGrantsPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse, any, {}>>;
|
|
2325
3088
|
/**
|
|
2326
3089
|
* This endpoint initiates a processing run for a selected application and version, and returns a `run_id` for tracking purposes. Slide processing occurs asynchronously, allowing you to retrieve results for individual slides as soon as they complete processing. The system typically processes slides in batches. Below is an example of the required payload for initiating an Atlas H&E TME processing run. ### Payload The payload includes `application_id`, optional `version_number`, and `items` base fields. `application_id` is the unique identifier for the application. `version_number` is the semantic version to use. If not provided, the latest available version will be used. `items` includes the list of the items to process (slides, in case of HETA application). Every item has a set of standard fields defined by the API, plus the custom_metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_id: \"he-tme\", version_number: \"1.0.0-beta\", items: [{ \"external_id\": \"slide_1\", \"custom_metadata\": {\"project\": \"sample-study\"}, \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"metadata\": { \"specimen\": { \"disease\": \"LUNG_CANCER\", \"tissue\": \"LUNG\" }, \"staining_method\": \"H&E\", \"width_px\": 136223, \"height_px\": 87761, \"resolution_mpp\": 0.2628238, \"media-type\":\"image/tiff\", \"checksum_base64_crc32c\": \"64RKKA==\" } }] }] } ``` | Parameter | Description | | :---- | :---- | | `application_id` required | Unique ID for the application | | `version_number` optional | Semantic version of the application. If not provided, the latest available version will be used | | `items` required | List of submitted items i.e. whole slide images (WSIs) with parameters described below. | | `external_id` required | Unique WSI name or ID for easy reference to items, provided by the caller. The `external_id` should be unique across all items of the run. | | `input_artifacts` required | List of provided artifacts for a WSI; at the moment Atlas H&E-TME receives only 1 artifact per slide (the slide itself), but for some other applications this can be a slide and a segmentation map | | `name` required | Type of artifact; Atlas H&E-TME supports only `\"input_slide\"` | | `download_url` required | Signed URL to the input file in the S3 or GCS; Should be valid for at least 6 days | | `specimen: disease` required | Supported cancer types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `specimen: tissue` required | Supported tissue types for Atlas H&E-TME (see full list in Atlas H&E-TME manual) | | `staining_method` required | WSI stain bio-marker; Atlas H&E-TME supports only `\"H&E\"` | | `width_px` required | Integer value. Number of pixels of the WSI in the X dimension. | | `height_px` required | Integer value. Number of pixels of the WSI in the Y dimension. | | `resolution_mpp` required | Resolution of WSI in micrometers per pixel; check allowed range in Atlas H&E-TME manual | | `media-type` required | Supported media formats; available values are: image/tiff (for .tiff or .tif WSI), application/dicom (for DICOM ), application/zip (for zipped DICOM), and application/octet-stream (for .svs WSI) | | `checksum_base64_crc32c` required | Base64-encoded big-endian CRC32C checksum of the WSI image | ### Response The endpoint returns the run UUID. After that, the job is scheduled for the execution in the background. To check the status of the run, call `GET v1/runs/{run_id}` endpoint with the returned run UUID. ### Rejection Apart from the authentication, authorization, and malformed input error, the request can be rejected when specific quota limit is exceeded. More details on quotas is described in the documentation
|
|
2327
3090
|
* @summary Initiate Run
|
|
@@ -2331,6 +3094,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2331
3094
|
* @memberof PublicApi
|
|
2332
3095
|
*/
|
|
2333
3096
|
createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunCreationResponse, any, {}>>;
|
|
3097
|
+
/**
|
|
3098
|
+
* Create a share token. The returned share_token value is shown only once and is never stored. Use POST /access/grants with subject_type=share_token to grant access to a resource.
|
|
3099
|
+
* @summary Create Share Token
|
|
3100
|
+
* @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
|
|
3101
|
+
* @param {*} [options] Override http request option.
|
|
3102
|
+
* @throws {RequiredError}
|
|
3103
|
+
* @memberof PublicApi
|
|
3104
|
+
*/
|
|
3105
|
+
createShareTokenV1AccessShareTokensPost(requestParameters: PublicApiCreateShareTokenV1AccessShareTokensPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenCreateResponse, any, {}>>;
|
|
2334
3106
|
/**
|
|
2335
3107
|
* This endpoint allows the caller to explicitly delete artifacts generated by a run. It can only be invoked when the run has reached a final state, i.e. `PROCESSED`, `CANCELED_SYSTEM`, or `CANCELED_USER`. Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests such deletion.
|
|
2336
3108
|
* @summary Delete Run Items
|
|
@@ -2349,6 +3121,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2349
3121
|
* @memberof PublicApi
|
|
2350
3122
|
*/
|
|
2351
3123
|
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
3124
|
+
/**
|
|
3125
|
+
* Get a grant by its ID.
|
|
3126
|
+
* @summary Get Grant
|
|
3127
|
+
* @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
|
|
3128
|
+
* @param {*} [options] Override http request option.
|
|
3129
|
+
* @throws {RequiredError}
|
|
3130
|
+
* @memberof PublicApi
|
|
3131
|
+
*/
|
|
3132
|
+
getGrantV1AccessGrantsGrantIdGet(requestParameters: PublicApiGetGrantV1AccessGrantsGrantIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse, any, {}>>;
|
|
2352
3133
|
/**
|
|
2353
3134
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
2354
3135
|
* @summary Get Item By Run
|
|
@@ -2367,7 +3148,7 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2367
3148
|
*/
|
|
2368
3149
|
getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<MeReadResponse, any, {}>>;
|
|
2369
3150
|
/**
|
|
2370
|
-
* 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.
|
|
3151
|
+
* This endpoint allows the caller to retrieve the current status of a run along with other relevant run details. A run becomes available immediately after it is created through the `POST /v1/runs/` endpoint. To download the output results, use `GET /v1/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it, or users with an active grant or valid share token.
|
|
2371
3152
|
* @summary Get run details
|
|
2372
3153
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
2373
3154
|
* @param {*} [options] Override http request option.
|
|
@@ -2375,6 +3156,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2375
3156
|
* @memberof PublicApi
|
|
2376
3157
|
*/
|
|
2377
3158
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse, any, {}>>;
|
|
3159
|
+
/**
|
|
3160
|
+
* Get a share token by its ID.
|
|
3161
|
+
* @summary Get Share Token
|
|
3162
|
+
* @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
|
|
3163
|
+
* @param {*} [options] Override http request option.
|
|
3164
|
+
* @throws {RequiredError}
|
|
3165
|
+
* @memberof PublicApi
|
|
3166
|
+
*/
|
|
3167
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters: PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenReadResponse, any, {}>>;
|
|
2378
3168
|
/**
|
|
2379
3169
|
* Return metadata for a single public document attached to an application version.
|
|
2380
3170
|
* @summary Get version document metadata
|
|
@@ -2411,6 +3201,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2411
3201
|
* @memberof PublicApi
|
|
2412
3202
|
*/
|
|
2413
3203
|
listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadShortResponse[], any, {}>>;
|
|
3204
|
+
/**
|
|
3205
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
3206
|
+
* @summary List Grants
|
|
3207
|
+
* @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
|
|
3208
|
+
* @param {*} [options] Override http request option.
|
|
3209
|
+
* @throws {RequiredError}
|
|
3210
|
+
* @memberof PublicApi
|
|
3211
|
+
*/
|
|
3212
|
+
listGrantsV1AccessGrantsGet(requestParameters?: PublicApiListGrantsV1AccessGrantsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse[], any, {}>>;
|
|
2414
3213
|
/**
|
|
2415
3214
|
* List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by `item_id`, `external_ids`, `custom_metadata`, `terminated_at`, and `termination_reason` using JSONPath expressions. ## JSONPath Metadata Filtering Use PostgreSQL JSONPath expressions to filter items using their custom_metadata. ### Examples: - **Field existence**: `$.case_id` - Results that have a case_id field defined - **Exact value match**: `$.priority ? (@ == \"high\")` - Results with high priority - **Numeric comparison**: `$.confidence_score ? (@ > 0.95)` - Results with high confidence - **Array operations**: `$.flags[*] ? (@ == \"reviewed\")` - Results flagged as reviewed - **Complex conditions**: `$.metrics ? (@.accuracy > 0.9 && @.recall > 0.8)` - Results meeting performance thresholds ## Notes - JSONPath expressions are evaluated using PostgreSQL\'s `@?` operator - The `$.` prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use `&&` for AND operations and `||` for OR operations
|
|
2416
3215
|
* @summary List Run Items
|
|
@@ -2429,6 +3228,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2429
3228
|
* @memberof PublicApi
|
|
2430
3229
|
*/
|
|
2431
3230
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse[], any, {}>>;
|
|
3231
|
+
/**
|
|
3232
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
3233
|
+
* @summary List Share Tokens
|
|
3234
|
+
* @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
|
|
3235
|
+
* @param {*} [options] Override http request option.
|
|
3236
|
+
* @throws {RequiredError}
|
|
3237
|
+
* @memberof PublicApi
|
|
3238
|
+
*/
|
|
3239
|
+
listShareTokensV1AccessShareTokensGet(requestParameters?: PublicApiListShareTokensV1AccessShareTokensGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenReadResponse[], any, {}>>;
|
|
2432
3240
|
/**
|
|
2433
3241
|
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
2434
3242
|
* @summary List version documents
|
|
@@ -2465,6 +3273,24 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2465
3273
|
* @memberof PublicApi
|
|
2466
3274
|
*/
|
|
2467
3275
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadResponse, any, {}>>;
|
|
3276
|
+
/**
|
|
3277
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
3278
|
+
* @summary Revoke Grant
|
|
3279
|
+
* @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
|
|
3280
|
+
* @param {*} [options] Override http request option.
|
|
3281
|
+
* @throws {RequiredError}
|
|
3282
|
+
* @memberof PublicApi
|
|
3283
|
+
*/
|
|
3284
|
+
revokeGrantV1AccessGrantsGrantIdDelete(requestParameters: PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse, any, {}>>;
|
|
3285
|
+
/**
|
|
3286
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
3287
|
+
* @summary Revoke Share Token
|
|
3288
|
+
* @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
|
|
3289
|
+
* @param {*} [options] Override http request option.
|
|
3290
|
+
* @throws {RequiredError}
|
|
3291
|
+
* @memberof PublicApi
|
|
3292
|
+
*/
|
|
3293
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters: PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenReadResponse, any, {}>>;
|
|
2468
3294
|
}
|
|
2469
3295
|
|
|
2470
|
-
export { type
|
|
3296
|
+
export { type PublicApiCreateRunV1RunsPostRequest as $, type ApplicationReadShortResponse as A, type SchedulingResponse as B, type CustomMetadataUpdateRequest as C, type ShareTokenCreateRequest as D, type ShareTokenCreateResponse as E, type ShareTokenReadResponse as F, type GrantCreateRequest as G, type HTTPValidationError as H, type ItemResultReadResponse as I, SubjectType as J, type ValidationError as K, type ValidationErrorLocInner as L, type MeReadResponse as M, type VersionDocumentResponse as N, type OrganizationReadResponse as O, VersionDocumentVisibility as P, PublicApiAxiosParamCreator as Q, type RunReadResponse as R, type SchedulingRequest as S, PublicApiFp as T, type UserReadResponse as U, type VersionReadResponse as V, PublicApiFactory as W, type PublicApiInterface as X, type PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest as Y, type PublicApiCancelRunV1RunsRunIdCancelPostRequest as Z, type PublicApiCreateGrantV1AccessGrantsPostRequest as _, type ApplicationReadResponse as a, type PublicApiCreateShareTokenV1AccessShareTokensPostRequest as a0, type PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest as a1, type PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest as a2, type PublicApiGetGrantV1AccessGrantsGrantIdGetRequest as a3, type PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest as a4, type PublicApiGetRunV1RunsRunIdGetRequest as a5, type PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest as a6, type PublicApiGetVersionDocumentRequest as a7, type PublicApiGetVersionDocumentContentRequest as a8, type PublicApiGetVersionDocumentFileRequest as a9, type PublicApiListApplicationsV1ApplicationsGetRequest as aa, type PublicApiListGrantsV1AccessGrantsGetRequest as ab, type PublicApiListRunItemsV1RunsRunIdItemsGetRequest as ac, type PublicApiListRunsV1RunsGetRequest as ad, type PublicApiListShareTokensV1AccessShareTokensGetRequest as ae, type PublicApiListVersionDocumentsRequest as af, type PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest as ag, type PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest as ah, type PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest as ai, type PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest as aj, type PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest as ak, PublicApi as al, type ConfigurationParameters as am, Configuration as an, type RunCreationRequest as b, type RunCreationResponse as c, ItemState as d, ItemTerminationReason as e, type ApplicationVersion as f, ArtifactOutput as g, ArtifactState as h, ArtifactTerminationReason as i, type CustomMetadataUpdateResponse as j, type GrantReadResponse as k, GrantRelation as l, type InputArtifact as m, type InputArtifactCreationRequest as n, type InputArtifactResultReadResponse as o, type ItemCreationRequest as p, ItemOutput as q, type OutputArtifact as r, type OutputArtifactResultReadResponse as s, OutputArtifactScope as t, OutputArtifactVisibility as u, ResourceType as v, type RunItemStatistics as w, RunOutput as x, RunState as y, RunTerminationReason as z };
|