@aignostics/sdk 3.3.0 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aignostics-sdk-3.5.0.tgz +0 -0
- package/dist/{api-CWohsFN3.d.cts → api-CrZaHZZr.d.cts} +1187 -23
- package/dist/{api-CWohsFN3.d.ts → api-CrZaHZZr.d.ts} +1187 -23
- package/dist/index.cjs +1211 -25
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +36 -2
- package/dist/index.d.ts +36 -2
- package/dist/index.js +1208 -26
- package/dist/index.js.map +1 -1
- package/dist/test-utils/http-mocks.cjs +26 -1
- package/dist/test-utils/http-mocks.cjs.map +1 -1
- package/dist/test-utils/http-mocks.d.cts +1 -1
- package/dist/test-utils/http-mocks.d.ts +1 -1
- package/dist/test-utils/http-mocks.js +26 -1
- package/dist/test-utils/http-mocks.js.map +1 -1
- package/package.json +2 -1
- package/dist/aignostics-sdk-3.3.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.6.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.6.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
|
|
@@ -355,6 +470,39 @@ interface InputArtifactCreationRequest {
|
|
|
355
470
|
[key: string]: any;
|
|
356
471
|
};
|
|
357
472
|
}
|
|
473
|
+
/**
|
|
474
|
+
*
|
|
475
|
+
* @export
|
|
476
|
+
* @interface InputArtifactResultReadResponse
|
|
477
|
+
*/
|
|
478
|
+
interface InputArtifactResultReadResponse {
|
|
479
|
+
/**
|
|
480
|
+
* The Id of the artifact. Used internally
|
|
481
|
+
* @type {string}
|
|
482
|
+
* @memberof InputArtifactResultReadResponse
|
|
483
|
+
*/
|
|
484
|
+
'input_artifact_id': string;
|
|
485
|
+
/**
|
|
486
|
+
* Name of the input from the schema from the `/v1/versions/{version_id}` endpoint.
|
|
487
|
+
* @type {string}
|
|
488
|
+
* @memberof InputArtifactResultReadResponse
|
|
489
|
+
*/
|
|
490
|
+
'name': string;
|
|
491
|
+
/**
|
|
492
|
+
*
|
|
493
|
+
* @type {{ [key: string]: any; }}
|
|
494
|
+
* @memberof InputArtifactResultReadResponse
|
|
495
|
+
*/
|
|
496
|
+
'metadata'?: {
|
|
497
|
+
[key: string]: any;
|
|
498
|
+
} | null;
|
|
499
|
+
/**
|
|
500
|
+
*
|
|
501
|
+
* @type {string}
|
|
502
|
+
* @memberof InputArtifactResultReadResponse
|
|
503
|
+
*/
|
|
504
|
+
'download_url'?: string | null;
|
|
505
|
+
}
|
|
358
506
|
/**
|
|
359
507
|
* Individual item (slide) to be processed in a run.
|
|
360
508
|
* @export
|
|
@@ -472,6 +620,12 @@ interface ItemResultReadResponse {
|
|
|
472
620
|
* @memberof ItemResultReadResponse
|
|
473
621
|
*/
|
|
474
622
|
'terminated_at'?: string | null;
|
|
623
|
+
/**
|
|
624
|
+
* The input artifact(s) provided by the user. For most applications, this will be one artifact that defines the whole slide image to be processed.
|
|
625
|
+
* @type {Array<InputArtifactResultReadResponse>}
|
|
626
|
+
* @memberof ItemResultReadResponse
|
|
627
|
+
*/
|
|
628
|
+
'input_artifacts': Array<InputArtifactResultReadResponse>;
|
|
475
629
|
/**
|
|
476
630
|
* The list of the results generated by the application algorithm. The number of files and their types depend on the particular application version, call `/v1/versions/{version_id}` to get the details.
|
|
477
631
|
* @type {Array<OutputArtifactResultReadResponse>}
|
|
@@ -704,6 +858,18 @@ declare const OutputArtifactVisibility: {
|
|
|
704
858
|
readonly External: "EXTERNAL";
|
|
705
859
|
};
|
|
706
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];
|
|
707
873
|
/**
|
|
708
874
|
* Request schema for `Initiate Run` endpoint. It describes which application version is chosen, and which user data should be processed.
|
|
709
875
|
* @export
|
|
@@ -736,6 +902,14 @@ interface RunCreationRequest {
|
|
|
736
902
|
* @memberof RunCreationRequest
|
|
737
903
|
*/
|
|
738
904
|
'scheduling'?: SchedulingRequest | null;
|
|
905
|
+
/**
|
|
906
|
+
*
|
|
907
|
+
* @type {{ [key: string]: any; }}
|
|
908
|
+
* @memberof RunCreationRequest
|
|
909
|
+
*/
|
|
910
|
+
'callback_context'?: {
|
|
911
|
+
[key: string]: any;
|
|
912
|
+
} | null;
|
|
739
913
|
/**
|
|
740
914
|
* List of items (slides) to process. Each item represents a whole slide image (WSI) with its associated metadata and artifacts
|
|
741
915
|
* @type {Array<ItemCreationRequest>}
|
|
@@ -987,6 +1161,99 @@ interface SchedulingResponse {
|
|
|
987
1161
|
*/
|
|
988
1162
|
'deadline'?: string | null;
|
|
989
1163
|
}
|
|
1164
|
+
/**
|
|
1165
|
+
*
|
|
1166
|
+
* @export
|
|
1167
|
+
* @interface ShareTokenCreateRequest
|
|
1168
|
+
*/
|
|
1169
|
+
interface ShareTokenCreateRequest {
|
|
1170
|
+
/**
|
|
1171
|
+
*
|
|
1172
|
+
* @type {string}
|
|
1173
|
+
* @memberof ShareTokenCreateRequest
|
|
1174
|
+
*/
|
|
1175
|
+
'expires_at'?: string | null;
|
|
1176
|
+
}
|
|
1177
|
+
/**
|
|
1178
|
+
* Returned only on POST — includes the one-time share_token.
|
|
1179
|
+
* @export
|
|
1180
|
+
* @interface ShareTokenCreateResponse
|
|
1181
|
+
*/
|
|
1182
|
+
interface ShareTokenCreateResponse {
|
|
1183
|
+
/**
|
|
1184
|
+
*
|
|
1185
|
+
* @type {string}
|
|
1186
|
+
* @memberof ShareTokenCreateResponse
|
|
1187
|
+
*/
|
|
1188
|
+
'share_token_id': string;
|
|
1189
|
+
/**
|
|
1190
|
+
*
|
|
1191
|
+
* @type {string}
|
|
1192
|
+
* @memberof ShareTokenCreateResponse
|
|
1193
|
+
*/
|
|
1194
|
+
'share_token': string;
|
|
1195
|
+
/**
|
|
1196
|
+
*
|
|
1197
|
+
* @type {string}
|
|
1198
|
+
* @memberof ShareTokenCreateResponse
|
|
1199
|
+
*/
|
|
1200
|
+
'created_at': string;
|
|
1201
|
+
/**
|
|
1202
|
+
*
|
|
1203
|
+
* @type {string}
|
|
1204
|
+
* @memberof ShareTokenCreateResponse
|
|
1205
|
+
*/
|
|
1206
|
+
'expires_at': string | null;
|
|
1207
|
+
/**
|
|
1208
|
+
*
|
|
1209
|
+
* @type {boolean}
|
|
1210
|
+
* @memberof ShareTokenCreateResponse
|
|
1211
|
+
*/
|
|
1212
|
+
'revoked': boolean;
|
|
1213
|
+
}
|
|
1214
|
+
/**
|
|
1215
|
+
* Returned on GET endpoints — omits share_token.
|
|
1216
|
+
* @export
|
|
1217
|
+
* @interface ShareTokenReadResponse
|
|
1218
|
+
*/
|
|
1219
|
+
interface ShareTokenReadResponse {
|
|
1220
|
+
/**
|
|
1221
|
+
*
|
|
1222
|
+
* @type {string}
|
|
1223
|
+
* @memberof ShareTokenReadResponse
|
|
1224
|
+
*/
|
|
1225
|
+
'share_token_id': string;
|
|
1226
|
+
/**
|
|
1227
|
+
*
|
|
1228
|
+
* @type {string}
|
|
1229
|
+
* @memberof ShareTokenReadResponse
|
|
1230
|
+
*/
|
|
1231
|
+
'created_at': string;
|
|
1232
|
+
/**
|
|
1233
|
+
*
|
|
1234
|
+
* @type {string}
|
|
1235
|
+
* @memberof ShareTokenReadResponse
|
|
1236
|
+
*/
|
|
1237
|
+
'expires_at': string | null;
|
|
1238
|
+
/**
|
|
1239
|
+
*
|
|
1240
|
+
* @type {boolean}
|
|
1241
|
+
* @memberof ShareTokenReadResponse
|
|
1242
|
+
*/
|
|
1243
|
+
'revoked': boolean;
|
|
1244
|
+
}
|
|
1245
|
+
/**
|
|
1246
|
+
*
|
|
1247
|
+
* @export
|
|
1248
|
+
* @enum {string}
|
|
1249
|
+
*/
|
|
1250
|
+
declare const SubjectType: {
|
|
1251
|
+
readonly User: "user";
|
|
1252
|
+
readonly OrganizationAdmin: "organization_admin";
|
|
1253
|
+
readonly OrganizationUser: "organization_user";
|
|
1254
|
+
readonly ShareToken: "share_token";
|
|
1255
|
+
};
|
|
1256
|
+
type SubjectType = typeof SubjectType[keyof typeof SubjectType];
|
|
990
1257
|
/**
|
|
991
1258
|
* 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
|
|
992
1259
|
* @export
|
|
@@ -1092,6 +1359,59 @@ interface ValidationError {
|
|
|
1092
1359
|
*/
|
|
1093
1360
|
interface ValidationErrorLocInner {
|
|
1094
1361
|
}
|
|
1362
|
+
/**
|
|
1363
|
+
*
|
|
1364
|
+
* @export
|
|
1365
|
+
* @interface VersionDocumentResponse
|
|
1366
|
+
*/
|
|
1367
|
+
interface VersionDocumentResponse {
|
|
1368
|
+
/**
|
|
1369
|
+
*
|
|
1370
|
+
* @type {string}
|
|
1371
|
+
* @memberof VersionDocumentResponse
|
|
1372
|
+
*/
|
|
1373
|
+
'id': string;
|
|
1374
|
+
/**
|
|
1375
|
+
*
|
|
1376
|
+
* @type {string}
|
|
1377
|
+
* @memberof VersionDocumentResponse
|
|
1378
|
+
*/
|
|
1379
|
+
'name': string;
|
|
1380
|
+
/**
|
|
1381
|
+
*
|
|
1382
|
+
* @type {string}
|
|
1383
|
+
* @memberof VersionDocumentResponse
|
|
1384
|
+
*/
|
|
1385
|
+
'mime_type': string;
|
|
1386
|
+
/**
|
|
1387
|
+
*
|
|
1388
|
+
* @type {VersionDocumentVisibility}
|
|
1389
|
+
* @memberof VersionDocumentResponse
|
|
1390
|
+
*/
|
|
1391
|
+
'visibility': VersionDocumentVisibility;
|
|
1392
|
+
/**
|
|
1393
|
+
*
|
|
1394
|
+
* @type {string}
|
|
1395
|
+
* @memberof VersionDocumentResponse
|
|
1396
|
+
*/
|
|
1397
|
+
'created_at': string;
|
|
1398
|
+
/**
|
|
1399
|
+
*
|
|
1400
|
+
* @type {string}
|
|
1401
|
+
* @memberof VersionDocumentResponse
|
|
1402
|
+
*/
|
|
1403
|
+
'updated_at': string;
|
|
1404
|
+
}
|
|
1405
|
+
/**
|
|
1406
|
+
*
|
|
1407
|
+
* @export
|
|
1408
|
+
* @enum {string}
|
|
1409
|
+
*/
|
|
1410
|
+
declare const VersionDocumentVisibility: {
|
|
1411
|
+
readonly Public: "public";
|
|
1412
|
+
readonly Internal: "internal";
|
|
1413
|
+
};
|
|
1414
|
+
type VersionDocumentVisibility = typeof VersionDocumentVisibility[keyof typeof VersionDocumentVisibility];
|
|
1095
1415
|
/**
|
|
1096
1416
|
* Base Response schema for the `Application Version Details` endpoint
|
|
1097
1417
|
* @export
|
|
@@ -1151,6 +1471,14 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1151
1471
|
* @throws {RequiredError}
|
|
1152
1472
|
*/
|
|
1153
1473
|
cancelRunV1RunsRunIdCancelPost: (runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1474
|
+
/**
|
|
1475
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
1476
|
+
* @summary Create Grant
|
|
1477
|
+
* @param {GrantCreateRequest} grantCreateRequest
|
|
1478
|
+
* @param {*} [options] Override http request option.
|
|
1479
|
+
* @throws {RequiredError}
|
|
1480
|
+
*/
|
|
1481
|
+
createGrantV1AccessGrantsPost: (grantCreateRequest: GrantCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1154
1482
|
/**
|
|
1155
1483
|
* 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
|
|
1156
1484
|
* @summary Initiate Run
|
|
@@ -1159,6 +1487,14 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1159
1487
|
* @throws {RequiredError}
|
|
1160
1488
|
*/
|
|
1161
1489
|
createRunV1RunsPost: (runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1490
|
+
/**
|
|
1491
|
+
* 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.
|
|
1492
|
+
* @summary Create Share Token
|
|
1493
|
+
* @param {ShareTokenCreateRequest} shareTokenCreateRequest
|
|
1494
|
+
* @param {*} [options] Override http request option.
|
|
1495
|
+
* @throws {RequiredError}
|
|
1496
|
+
*/
|
|
1497
|
+
createShareTokenV1AccessShareTokensPost: (shareTokenCreateRequest: ShareTokenCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1162
1498
|
/**
|
|
1163
1499
|
* 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.
|
|
1164
1500
|
* @summary Delete Run Items
|
|
@@ -1172,19 +1508,29 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1172
1508
|
* @summary Get Artifact Url
|
|
1173
1509
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1174
1510
|
* @param {string} artifactId The artifact id to download
|
|
1511
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1512
|
+
* @param {*} [options] Override http request option.
|
|
1513
|
+
* @throws {RequiredError}
|
|
1514
|
+
*/
|
|
1515
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet: (runId: string, artifactId: string, shareToken?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1516
|
+
/**
|
|
1517
|
+
* Get a grant by its ID.
|
|
1518
|
+
* @summary Get Grant
|
|
1519
|
+
* @param {string} grantId Grant ID
|
|
1175
1520
|
* @param {*} [options] Override http request option.
|
|
1176
1521
|
* @throws {RequiredError}
|
|
1177
1522
|
*/
|
|
1178
|
-
|
|
1523
|
+
getGrantV1AccessGrantsGrantIdGet: (grantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1179
1524
|
/**
|
|
1180
1525
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1181
1526
|
* @summary Get Item By Run
|
|
1182
1527
|
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
1183
1528
|
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1529
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1184
1530
|
* @param {*} [options] Override http request option.
|
|
1185
1531
|
* @throws {RequiredError}
|
|
1186
1532
|
*/
|
|
1187
|
-
getItemByRunV1RunsRunIdItemsExternalIdGet: (runId: string, externalId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1533
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet: (runId: string, externalId: string, shareToken?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1188
1534
|
/**
|
|
1189
1535
|
* 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)
|
|
1190
1536
|
* @summary Get current user
|
|
@@ -1193,13 +1539,52 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1193
1539
|
*/
|
|
1194
1540
|
getMeV1MeGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1195
1541
|
/**
|
|
1196
|
-
* 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.
|
|
1542
|
+
* 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.
|
|
1197
1543
|
* @summary Get run details
|
|
1198
1544
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1545
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1546
|
+
* @param {*} [options] Override http request option.
|
|
1547
|
+
* @throws {RequiredError}
|
|
1548
|
+
*/
|
|
1549
|
+
getRunV1RunsRunIdGet: (runId: string, shareToken?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1550
|
+
/**
|
|
1551
|
+
* Get a share token by its ID.
|
|
1552
|
+
* @summary Get Share Token
|
|
1553
|
+
* @param {string} shareTokenId Share token ID
|
|
1554
|
+
* @param {*} [options] Override http request option.
|
|
1555
|
+
* @throws {RequiredError}
|
|
1556
|
+
*/
|
|
1557
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet: (shareTokenId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1558
|
+
/**
|
|
1559
|
+
* Return metadata for a single public document attached to an application version.
|
|
1560
|
+
* @summary Get version document metadata
|
|
1561
|
+
* @param {string} applicationId
|
|
1562
|
+
* @param {string} version
|
|
1563
|
+
* @param {string} name
|
|
1564
|
+
* @param {*} [options] Override http request option.
|
|
1565
|
+
* @throws {RequiredError}
|
|
1566
|
+
*/
|
|
1567
|
+
getVersionDocument: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1568
|
+
/**
|
|
1569
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
1570
|
+
* @summary Stream version document content (programmatic)
|
|
1571
|
+
* @param {string} applicationId
|
|
1572
|
+
* @param {string} version
|
|
1573
|
+
* @param {string} name
|
|
1574
|
+
* @param {*} [options] Override http request option.
|
|
1575
|
+
* @throws {RequiredError}
|
|
1576
|
+
*/
|
|
1577
|
+
getVersionDocumentContent: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1578
|
+
/**
|
|
1579
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
1580
|
+
* @summary Download version document (browser)
|
|
1581
|
+
* @param {string} applicationId
|
|
1582
|
+
* @param {string} version
|
|
1583
|
+
* @param {string} name
|
|
1199
1584
|
* @param {*} [options] Override http request option.
|
|
1200
1585
|
* @throws {RequiredError}
|
|
1201
1586
|
*/
|
|
1202
|
-
|
|
1587
|
+
getVersionDocumentFile: (applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1203
1588
|
/**
|
|
1204
1589
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
1205
1590
|
* @summary List available applications
|
|
@@ -1210,10 +1595,26 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1210
1595
|
* @throws {RequiredError}
|
|
1211
1596
|
*/
|
|
1212
1597
|
listApplicationsV1ApplicationsGet: (page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1598
|
+
/**
|
|
1599
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
1600
|
+
* @summary List Grants
|
|
1601
|
+
* @param {ResourceType | null} [resourceType]
|
|
1602
|
+
* @param {string | null} [resourceId]
|
|
1603
|
+
* @param {SubjectType | null} [subjectType]
|
|
1604
|
+
* @param {string | null} [subjectId]
|
|
1605
|
+
* @param {boolean | null} [revoked]
|
|
1606
|
+
* @param {number} [page]
|
|
1607
|
+
* @param {number} [pageSize]
|
|
1608
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1609
|
+
* @param {*} [options] Override http request option.
|
|
1610
|
+
* @throws {RequiredError}
|
|
1611
|
+
*/
|
|
1612
|
+
listGrantsV1AccessGrantsGet: (resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1213
1613
|
/**
|
|
1214
1614
|
* 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
|
|
1215
1615
|
* @summary List Run Items
|
|
1216
1616
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1617
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1217
1618
|
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
1218
1619
|
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
1219
1620
|
* @param {ItemState | null} [state] Filter items by their state
|
|
@@ -1225,7 +1626,7 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1225
1626
|
* @param {*} [options] Override http request option.
|
|
1226
1627
|
* @throws {RequiredError}
|
|
1227
1628
|
*/
|
|
1228
|
-
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>;
|
|
1629
|
+
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>;
|
|
1229
1630
|
/**
|
|
1230
1631
|
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
1231
1632
|
* @summary List Runs
|
|
@@ -1242,17 +1643,39 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1242
1643
|
*/
|
|
1243
1644
|
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>;
|
|
1244
1645
|
/**
|
|
1245
|
-
*
|
|
1246
|
-
* @summary
|
|
1247
|
-
* @param {string} runId
|
|
1248
|
-
* @param {string
|
|
1249
|
-
* @param {
|
|
1646
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1647
|
+
* @summary List Share Tokens
|
|
1648
|
+
* @param {string | null} [runId] Filter by run ID
|
|
1649
|
+
* @param {string | null} [createdBy] Filter by share token creator
|
|
1650
|
+
* @param {boolean | null} [revoked]
|
|
1651
|
+
* @param {number} [page]
|
|
1652
|
+
* @param {number} [pageSize]
|
|
1653
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1250
1654
|
* @param {*} [options] Override http request option.
|
|
1251
1655
|
* @throws {RequiredError}
|
|
1252
1656
|
*/
|
|
1253
|
-
|
|
1657
|
+
listShareTokensV1AccessShareTokensGet: (runId?: string | null, createdBy?: string | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1254
1658
|
/**
|
|
1255
|
-
*
|
|
1659
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1660
|
+
* @summary List version documents
|
|
1661
|
+
* @param {string} applicationId
|
|
1662
|
+
* @param {string} version
|
|
1663
|
+
* @param {*} [options] Override http request option.
|
|
1664
|
+
* @throws {RequiredError}
|
|
1665
|
+
*/
|
|
1666
|
+
listVersionDocuments: (applicationId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1667
|
+
/**
|
|
1668
|
+
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
1669
|
+
* @summary Put Item Custom Metadata By Run
|
|
1670
|
+
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
1671
|
+
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1672
|
+
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
1673
|
+
* @param {*} [options] Override http request option.
|
|
1674
|
+
* @throws {RequiredError}
|
|
1675
|
+
*/
|
|
1676
|
+
putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut: (runId: string, externalId: string, customMetadataUpdateRequest: CustomMetadataUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1677
|
+
/**
|
|
1678
|
+
* Update the custom metadata of a run with the specified `run_id`. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for the run via the `GET /v1/runs/{run_id}` endpoint. **Note on deadlines:** Run deadlines must be set during run creation and cannot be modified afterward. Any deadline changes in custom metadata will be ignored by the system.
|
|
1256
1679
|
* @summary Put Run Custom Metadata
|
|
1257
1680
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1258
1681
|
* @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
|
|
@@ -1268,6 +1691,22 @@ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
1268
1691
|
* @throws {RequiredError}
|
|
1269
1692
|
*/
|
|
1270
1693
|
readApplicationByIdV1ApplicationsApplicationIdGet: (applicationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1694
|
+
/**
|
|
1695
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
1696
|
+
* @summary Revoke Grant
|
|
1697
|
+
* @param {string} grantId Grant ID
|
|
1698
|
+
* @param {*} [options] Override http request option.
|
|
1699
|
+
* @throws {RequiredError}
|
|
1700
|
+
*/
|
|
1701
|
+
revokeGrantV1AccessGrantsGrantIdDelete: (grantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1702
|
+
/**
|
|
1703
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1704
|
+
* @summary Revoke Share Token
|
|
1705
|
+
* @param {string} shareTokenId Share token ID
|
|
1706
|
+
* @param {*} [options] Override http request option.
|
|
1707
|
+
* @throws {RequiredError}
|
|
1708
|
+
*/
|
|
1709
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete: (shareTokenId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1271
1710
|
};
|
|
1272
1711
|
/**
|
|
1273
1712
|
* PublicApi - functional programming interface
|
|
@@ -1291,6 +1730,14 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1291
1730
|
* @throws {RequiredError}
|
|
1292
1731
|
*/
|
|
1293
1732
|
cancelRunV1RunsRunIdCancelPost(runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1733
|
+
/**
|
|
1734
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
1735
|
+
* @summary Create Grant
|
|
1736
|
+
* @param {GrantCreateRequest} grantCreateRequest
|
|
1737
|
+
* @param {*} [options] Override http request option.
|
|
1738
|
+
* @throws {RequiredError}
|
|
1739
|
+
*/
|
|
1740
|
+
createGrantV1AccessGrantsPost(grantCreateRequest: GrantCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GrantReadResponse>>;
|
|
1294
1741
|
/**
|
|
1295
1742
|
* 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
|
|
1296
1743
|
* @summary Initiate Run
|
|
@@ -1299,6 +1746,14 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1299
1746
|
* @throws {RequiredError}
|
|
1300
1747
|
*/
|
|
1301
1748
|
createRunV1RunsPost(runCreationRequest: RunCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunCreationResponse>>;
|
|
1749
|
+
/**
|
|
1750
|
+
* 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.
|
|
1751
|
+
* @summary Create Share Token
|
|
1752
|
+
* @param {ShareTokenCreateRequest} shareTokenCreateRequest
|
|
1753
|
+
* @param {*} [options] Override http request option.
|
|
1754
|
+
* @throws {RequiredError}
|
|
1755
|
+
*/
|
|
1756
|
+
createShareTokenV1AccessShareTokensPost(shareTokenCreateRequest: ShareTokenCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareTokenCreateResponse>>;
|
|
1302
1757
|
/**
|
|
1303
1758
|
* 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.
|
|
1304
1759
|
* @summary Delete Run Items
|
|
@@ -1312,19 +1767,29 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1312
1767
|
* @summary Get Artifact Url
|
|
1313
1768
|
* @param {string} runId Run id, returned by `POST /runs/` endpoint
|
|
1314
1769
|
* @param {string} artifactId The artifact id to download
|
|
1770
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1771
|
+
* @param {*} [options] Override http request option.
|
|
1772
|
+
* @throws {RequiredError}
|
|
1773
|
+
*/
|
|
1774
|
+
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(runId: string, artifactId: string, shareToken?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1775
|
+
/**
|
|
1776
|
+
* Get a grant by its ID.
|
|
1777
|
+
* @summary Get Grant
|
|
1778
|
+
* @param {string} grantId Grant ID
|
|
1315
1779
|
* @param {*} [options] Override http request option.
|
|
1316
1780
|
* @throws {RequiredError}
|
|
1317
1781
|
*/
|
|
1318
|
-
|
|
1782
|
+
getGrantV1AccessGrantsGrantIdGet(grantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GrantReadResponse>>;
|
|
1319
1783
|
/**
|
|
1320
1784
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1321
1785
|
* @summary Get Item By Run
|
|
1322
1786
|
* @param {string} runId The run id, returned by `POST /runs/` endpoint
|
|
1323
1787
|
* @param {string} externalId The `external_id` that was defined for the item by the customer that triggered the run.
|
|
1788
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1324
1789
|
* @param {*} [options] Override http request option.
|
|
1325
1790
|
* @throws {RequiredError}
|
|
1326
1791
|
*/
|
|
1327
|
-
getItemByRunV1RunsRunIdItemsExternalIdGet(runId: string, externalId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemResultReadResponse>>;
|
|
1792
|
+
getItemByRunV1RunsRunIdItemsExternalIdGet(runId: string, externalId: string, shareToken?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemResultReadResponse>>;
|
|
1328
1793
|
/**
|
|
1329
1794
|
* 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)
|
|
1330
1795
|
* @summary Get current user
|
|
@@ -1333,13 +1798,52 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1333
1798
|
*/
|
|
1334
1799
|
getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeReadResponse>>;
|
|
1335
1800
|
/**
|
|
1336
|
-
* 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.
|
|
1801
|
+
* 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.
|
|
1337
1802
|
* @summary Get run details
|
|
1338
1803
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1804
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1805
|
+
* @param {*} [options] Override http request option.
|
|
1806
|
+
* @throws {RequiredError}
|
|
1807
|
+
*/
|
|
1808
|
+
getRunV1RunsRunIdGet(runId: string, shareToken?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunReadResponse>>;
|
|
1809
|
+
/**
|
|
1810
|
+
* Get a share token by its ID.
|
|
1811
|
+
* @summary Get Share Token
|
|
1812
|
+
* @param {string} shareTokenId Share token ID
|
|
1813
|
+
* @param {*} [options] Override http request option.
|
|
1814
|
+
* @throws {RequiredError}
|
|
1815
|
+
*/
|
|
1816
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(shareTokenId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareTokenReadResponse>>;
|
|
1817
|
+
/**
|
|
1818
|
+
* Return metadata for a single public document attached to an application version.
|
|
1819
|
+
* @summary Get version document metadata
|
|
1820
|
+
* @param {string} applicationId
|
|
1821
|
+
* @param {string} version
|
|
1822
|
+
* @param {string} name
|
|
1823
|
+
* @param {*} [options] Override http request option.
|
|
1824
|
+
* @throws {RequiredError}
|
|
1825
|
+
*/
|
|
1826
|
+
getVersionDocument(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VersionDocumentResponse>>;
|
|
1827
|
+
/**
|
|
1828
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
1829
|
+
* @summary Stream version document content (programmatic)
|
|
1830
|
+
* @param {string} applicationId
|
|
1831
|
+
* @param {string} version
|
|
1832
|
+
* @param {string} name
|
|
1339
1833
|
* @param {*} [options] Override http request option.
|
|
1340
1834
|
* @throws {RequiredError}
|
|
1341
1835
|
*/
|
|
1342
|
-
|
|
1836
|
+
getVersionDocumentContent(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1837
|
+
/**
|
|
1838
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
1839
|
+
* @summary Download version document (browser)
|
|
1840
|
+
* @param {string} applicationId
|
|
1841
|
+
* @param {string} version
|
|
1842
|
+
* @param {string} name
|
|
1843
|
+
* @param {*} [options] Override http request option.
|
|
1844
|
+
* @throws {RequiredError}
|
|
1845
|
+
*/
|
|
1846
|
+
getVersionDocumentFile(applicationId: string, version: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1343
1847
|
/**
|
|
1344
1848
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
1345
1849
|
* @summary List available applications
|
|
@@ -1350,10 +1854,26 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1350
1854
|
* @throws {RequiredError}
|
|
1351
1855
|
*/
|
|
1352
1856
|
listApplicationsV1ApplicationsGet(page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicationReadShortResponse>>>;
|
|
1857
|
+
/**
|
|
1858
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
1859
|
+
* @summary List Grants
|
|
1860
|
+
* @param {ResourceType | null} [resourceType]
|
|
1861
|
+
* @param {string | null} [resourceId]
|
|
1862
|
+
* @param {SubjectType | null} [subjectType]
|
|
1863
|
+
* @param {string | null} [subjectId]
|
|
1864
|
+
* @param {boolean | null} [revoked]
|
|
1865
|
+
* @param {number} [page]
|
|
1866
|
+
* @param {number} [pageSize]
|
|
1867
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1868
|
+
* @param {*} [options] Override http request option.
|
|
1869
|
+
* @throws {RequiredError}
|
|
1870
|
+
*/
|
|
1871
|
+
listGrantsV1AccessGrantsGet(resourceType?: ResourceType | null, resourceId?: string | null, subjectType?: SubjectType | null, subjectId?: string | null, revoked?: boolean | null, page?: number, pageSize?: number, sort?: Array<string> | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GrantReadResponse>>>;
|
|
1353
1872
|
/**
|
|
1354
1873
|
* 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
|
|
1355
1874
|
* @summary List Run Items
|
|
1356
1875
|
* @param {string} runId Run id, returned by `POST /v1/runs/` endpoint
|
|
1876
|
+
* @param {string | null} [shareToken] Share token for accessing shared runs
|
|
1357
1877
|
* @param {Array<string> | null} [itemIdIn] Filter for item ids
|
|
1358
1878
|
* @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
|
|
1359
1879
|
* @param {ItemState | null} [state] Filter items by their state
|
|
@@ -1365,7 +1885,7 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1365
1885
|
* @param {*} [options] Override http request option.
|
|
1366
1886
|
* @throws {RequiredError}
|
|
1367
1887
|
*/
|
|
1368
|
-
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>>>;
|
|
1888
|
+
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>>>;
|
|
1369
1889
|
/**
|
|
1370
1890
|
* List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
|
|
1371
1891
|
* @summary List Runs
|
|
@@ -1381,6 +1901,28 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1381
1901
|
* @throws {RequiredError}
|
|
1382
1902
|
*/
|
|
1383
1903
|
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>>>;
|
|
1904
|
+
/**
|
|
1905
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
1906
|
+
* @summary List Share Tokens
|
|
1907
|
+
* @param {string | null} [runId] Filter by run ID
|
|
1908
|
+
* @param {string | null} [createdBy] Filter by share token creator
|
|
1909
|
+
* @param {boolean | null} [revoked]
|
|
1910
|
+
* @param {number} [page]
|
|
1911
|
+
* @param {number} [pageSize]
|
|
1912
|
+
* @param {Array<string> | null} [sort] Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
1913
|
+
* @param {*} [options] Override http request option.
|
|
1914
|
+
* @throws {RequiredError}
|
|
1915
|
+
*/
|
|
1916
|
+
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>>>;
|
|
1917
|
+
/**
|
|
1918
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
1919
|
+
* @summary List version documents
|
|
1920
|
+
* @param {string} applicationId
|
|
1921
|
+
* @param {string} version
|
|
1922
|
+
* @param {*} [options] Override http request option.
|
|
1923
|
+
* @throws {RequiredError}
|
|
1924
|
+
*/
|
|
1925
|
+
listVersionDocuments(applicationId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VersionDocumentResponse>>>;
|
|
1384
1926
|
/**
|
|
1385
1927
|
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
1386
1928
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1408,6 +1950,22 @@ declare const PublicApiFp: (configuration?: Configuration) => {
|
|
|
1408
1950
|
* @throws {RequiredError}
|
|
1409
1951
|
*/
|
|
1410
1952
|
readApplicationByIdV1ApplicationsApplicationIdGet(applicationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationReadResponse>>;
|
|
1953
|
+
/**
|
|
1954
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
1955
|
+
* @summary Revoke Grant
|
|
1956
|
+
* @param {string} grantId Grant ID
|
|
1957
|
+
* @param {*} [options] Override http request option.
|
|
1958
|
+
* @throws {RequiredError}
|
|
1959
|
+
*/
|
|
1960
|
+
revokeGrantV1AccessGrantsGrantIdDelete(grantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GrantReadResponse>>;
|
|
1961
|
+
/**
|
|
1962
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
1963
|
+
* @summary Revoke Share Token
|
|
1964
|
+
* @param {string} shareTokenId Share token ID
|
|
1965
|
+
* @param {*} [options] Override http request option.
|
|
1966
|
+
* @throws {RequiredError}
|
|
1967
|
+
*/
|
|
1968
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(shareTokenId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareTokenReadResponse>>;
|
|
1411
1969
|
};
|
|
1412
1970
|
/**
|
|
1413
1971
|
* PublicApi - factory interface
|
|
@@ -1430,6 +1988,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1430
1988
|
* @throws {RequiredError}
|
|
1431
1989
|
*/
|
|
1432
1990
|
cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
1991
|
+
/**
|
|
1992
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
1993
|
+
* @summary Create Grant
|
|
1994
|
+
* @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
|
|
1995
|
+
* @param {*} [options] Override http request option.
|
|
1996
|
+
* @throws {RequiredError}
|
|
1997
|
+
*/
|
|
1998
|
+
createGrantV1AccessGrantsPost(requestParameters: PublicApiCreateGrantV1AccessGrantsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
1433
1999
|
/**
|
|
1434
2000
|
* 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
|
|
1435
2001
|
* @summary Initiate Run
|
|
@@ -1438,6 +2004,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1438
2004
|
* @throws {RequiredError}
|
|
1439
2005
|
*/
|
|
1440
2006
|
createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
|
|
2007
|
+
/**
|
|
2008
|
+
* 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.
|
|
2009
|
+
* @summary Create Share Token
|
|
2010
|
+
* @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
|
|
2011
|
+
* @param {*} [options] Override http request option.
|
|
2012
|
+
* @throws {RequiredError}
|
|
2013
|
+
*/
|
|
2014
|
+
createShareTokenV1AccessShareTokensPost(requestParameters: PublicApiCreateShareTokenV1AccessShareTokensPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenCreateResponse>;
|
|
1441
2015
|
/**
|
|
1442
2016
|
* 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.
|
|
1443
2017
|
* @summary Delete Run Items
|
|
@@ -1454,6 +2028,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1454
2028
|
* @throws {RequiredError}
|
|
1455
2029
|
*/
|
|
1456
2030
|
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
2031
|
+
/**
|
|
2032
|
+
* Get a grant by its ID.
|
|
2033
|
+
* @summary Get Grant
|
|
2034
|
+
* @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
|
|
2035
|
+
* @param {*} [options] Override http request option.
|
|
2036
|
+
* @throws {RequiredError}
|
|
2037
|
+
*/
|
|
2038
|
+
getGrantV1AccessGrantsGrantIdGet(requestParameters: PublicApiGetGrantV1AccessGrantsGrantIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
1457
2039
|
/**
|
|
1458
2040
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1459
2041
|
* @summary Get Item By Run
|
|
@@ -1470,13 +2052,45 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1470
2052
|
*/
|
|
1471
2053
|
getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
|
|
1472
2054
|
/**
|
|
1473
|
-
* 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.
|
|
2055
|
+
* 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.
|
|
1474
2056
|
* @summary Get run details
|
|
1475
2057
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
1476
2058
|
* @param {*} [options] Override http request option.
|
|
1477
2059
|
* @throws {RequiredError}
|
|
1478
2060
|
*/
|
|
1479
2061
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
|
|
2062
|
+
/**
|
|
2063
|
+
* Get a share token by its ID.
|
|
2064
|
+
* @summary Get Share Token
|
|
2065
|
+
* @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
|
|
2066
|
+
* @param {*} [options] Override http request option.
|
|
2067
|
+
* @throws {RequiredError}
|
|
2068
|
+
*/
|
|
2069
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters: PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
|
|
2070
|
+
/**
|
|
2071
|
+
* Return metadata for a single public document attached to an application version.
|
|
2072
|
+
* @summary Get version document metadata
|
|
2073
|
+
* @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
|
|
2074
|
+
* @param {*} [options] Override http request option.
|
|
2075
|
+
* @throws {RequiredError}
|
|
2076
|
+
*/
|
|
2077
|
+
getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionDocumentResponse>;
|
|
2078
|
+
/**
|
|
2079
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
2080
|
+
* @summary Stream version document content (programmatic)
|
|
2081
|
+
* @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
|
|
2082
|
+
* @param {*} [options] Override http request option.
|
|
2083
|
+
* @throws {RequiredError}
|
|
2084
|
+
*/
|
|
2085
|
+
getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2086
|
+
/**
|
|
2087
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
2088
|
+
* @summary Download version document (browser)
|
|
2089
|
+
* @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
|
|
2090
|
+
* @param {*} [options] Override http request option.
|
|
2091
|
+
* @throws {RequiredError}
|
|
2092
|
+
*/
|
|
2093
|
+
getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1480
2094
|
/**
|
|
1481
2095
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
1482
2096
|
* @summary List available applications
|
|
@@ -1485,6 +2099,14 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1485
2099
|
* @throws {RequiredError}
|
|
1486
2100
|
*/
|
|
1487
2101
|
listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
|
|
2102
|
+
/**
|
|
2103
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
2104
|
+
* @summary List Grants
|
|
2105
|
+
* @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
|
|
2106
|
+
* @param {*} [options] Override http request option.
|
|
2107
|
+
* @throws {RequiredError}
|
|
2108
|
+
*/
|
|
2109
|
+
listGrantsV1AccessGrantsGet(requestParameters?: PublicApiListGrantsV1AccessGrantsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<GrantReadResponse>>;
|
|
1488
2110
|
/**
|
|
1489
2111
|
* 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
|
|
1490
2112
|
* @summary List Run Items
|
|
@@ -1501,6 +2123,22 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1501
2123
|
* @throws {RequiredError}
|
|
1502
2124
|
*/
|
|
1503
2125
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
|
|
2126
|
+
/**
|
|
2127
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
2128
|
+
* @summary List Share Tokens
|
|
2129
|
+
* @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
|
|
2130
|
+
* @param {*} [options] Override http request option.
|
|
2131
|
+
* @throws {RequiredError}
|
|
2132
|
+
*/
|
|
2133
|
+
listShareTokensV1AccessShareTokensGet(requestParameters?: PublicApiListShareTokensV1AccessShareTokensGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ShareTokenReadResponse>>;
|
|
2134
|
+
/**
|
|
2135
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
2136
|
+
* @summary List version documents
|
|
2137
|
+
* @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
|
|
2138
|
+
* @param {*} [options] Override http request option.
|
|
2139
|
+
* @throws {RequiredError}
|
|
2140
|
+
*/
|
|
2141
|
+
listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<VersionDocumentResponse>>;
|
|
1504
2142
|
/**
|
|
1505
2143
|
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
1506
2144
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1525,6 +2163,22 @@ declare const PublicApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
1525
2163
|
* @throws {RequiredError}
|
|
1526
2164
|
*/
|
|
1527
2165
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationReadResponse>;
|
|
2166
|
+
/**
|
|
2167
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
2168
|
+
* @summary Revoke Grant
|
|
2169
|
+
* @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
|
|
2170
|
+
* @param {*} [options] Override http request option.
|
|
2171
|
+
* @throws {RequiredError}
|
|
2172
|
+
*/
|
|
2173
|
+
revokeGrantV1AccessGrantsGrantIdDelete(requestParameters: PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
2174
|
+
/**
|
|
2175
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
2176
|
+
* @summary Revoke Share Token
|
|
2177
|
+
* @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
|
|
2178
|
+
* @param {*} [options] Override http request option.
|
|
2179
|
+
* @throws {RequiredError}
|
|
2180
|
+
*/
|
|
2181
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters: PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
|
|
1528
2182
|
};
|
|
1529
2183
|
/**
|
|
1530
2184
|
* PublicApi - interface
|
|
@@ -1550,6 +2204,15 @@ interface PublicApiInterface {
|
|
|
1550
2204
|
* @memberof PublicApiInterface
|
|
1551
2205
|
*/
|
|
1552
2206
|
cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
2207
|
+
/**
|
|
2208
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
2209
|
+
* @summary Create Grant
|
|
2210
|
+
* @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
|
|
2211
|
+
* @param {*} [options] Override http request option.
|
|
2212
|
+
* @throws {RequiredError}
|
|
2213
|
+
* @memberof PublicApiInterface
|
|
2214
|
+
*/
|
|
2215
|
+
createGrantV1AccessGrantsPost(requestParameters: PublicApiCreateGrantV1AccessGrantsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
1553
2216
|
/**
|
|
1554
2217
|
* 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
|
|
1555
2218
|
* @summary Initiate Run
|
|
@@ -1559,6 +2222,15 @@ interface PublicApiInterface {
|
|
|
1559
2222
|
* @memberof PublicApiInterface
|
|
1560
2223
|
*/
|
|
1561
2224
|
createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunCreationResponse>;
|
|
2225
|
+
/**
|
|
2226
|
+
* 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.
|
|
2227
|
+
* @summary Create Share Token
|
|
2228
|
+
* @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
|
|
2229
|
+
* @param {*} [options] Override http request option.
|
|
2230
|
+
* @throws {RequiredError}
|
|
2231
|
+
* @memberof PublicApiInterface
|
|
2232
|
+
*/
|
|
2233
|
+
createShareTokenV1AccessShareTokensPost(requestParameters: PublicApiCreateShareTokenV1AccessShareTokensPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenCreateResponse>;
|
|
1562
2234
|
/**
|
|
1563
2235
|
* 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.
|
|
1564
2236
|
* @summary Delete Run Items
|
|
@@ -1577,6 +2249,15 @@ interface PublicApiInterface {
|
|
|
1577
2249
|
* @memberof PublicApiInterface
|
|
1578
2250
|
*/
|
|
1579
2251
|
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
2252
|
+
/**
|
|
2253
|
+
* Get a grant by its ID.
|
|
2254
|
+
* @summary Get Grant
|
|
2255
|
+
* @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
|
|
2256
|
+
* @param {*} [options] Override http request option.
|
|
2257
|
+
* @throws {RequiredError}
|
|
2258
|
+
* @memberof PublicApiInterface
|
|
2259
|
+
*/
|
|
2260
|
+
getGrantV1AccessGrantsGrantIdGet(requestParameters: PublicApiGetGrantV1AccessGrantsGrantIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
1580
2261
|
/**
|
|
1581
2262
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
1582
2263
|
* @summary Get Item By Run
|
|
@@ -1595,7 +2276,7 @@ interface PublicApiInterface {
|
|
|
1595
2276
|
*/
|
|
1596
2277
|
getMeV1MeGet(options?: RawAxiosRequestConfig): AxiosPromise<MeReadResponse>;
|
|
1597
2278
|
/**
|
|
1598
|
-
* 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.
|
|
2279
|
+
* 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.
|
|
1599
2280
|
* @summary Get run details
|
|
1600
2281
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
1601
2282
|
* @param {*} [options] Override http request option.
|
|
@@ -1603,6 +2284,42 @@ interface PublicApiInterface {
|
|
|
1603
2284
|
* @memberof PublicApiInterface
|
|
1604
2285
|
*/
|
|
1605
2286
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunReadResponse>;
|
|
2287
|
+
/**
|
|
2288
|
+
* Get a share token by its ID.
|
|
2289
|
+
* @summary Get Share Token
|
|
2290
|
+
* @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
|
|
2291
|
+
* @param {*} [options] Override http request option.
|
|
2292
|
+
* @throws {RequiredError}
|
|
2293
|
+
* @memberof PublicApiInterface
|
|
2294
|
+
*/
|
|
2295
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters: PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
|
|
2296
|
+
/**
|
|
2297
|
+
* Return metadata for a single public document attached to an application version.
|
|
2298
|
+
* @summary Get version document metadata
|
|
2299
|
+
* @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
|
|
2300
|
+
* @param {*} [options] Override http request option.
|
|
2301
|
+
* @throws {RequiredError}
|
|
2302
|
+
* @memberof PublicApiInterface
|
|
2303
|
+
*/
|
|
2304
|
+
getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<VersionDocumentResponse>;
|
|
2305
|
+
/**
|
|
2306
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
2307
|
+
* @summary Stream version document content (programmatic)
|
|
2308
|
+
* @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
|
|
2309
|
+
* @param {*} [options] Override http request option.
|
|
2310
|
+
* @throws {RequiredError}
|
|
2311
|
+
* @memberof PublicApiInterface
|
|
2312
|
+
*/
|
|
2313
|
+
getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2314
|
+
/**
|
|
2315
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
2316
|
+
* @summary Download version document (browser)
|
|
2317
|
+
* @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
|
|
2318
|
+
* @param {*} [options] Override http request option.
|
|
2319
|
+
* @throws {RequiredError}
|
|
2320
|
+
* @memberof PublicApiInterface
|
|
2321
|
+
*/
|
|
2322
|
+
getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1606
2323
|
/**
|
|
1607
2324
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
1608
2325
|
* @summary List available applications
|
|
@@ -1612,6 +2329,15 @@ interface PublicApiInterface {
|
|
|
1612
2329
|
* @memberof PublicApiInterface
|
|
1613
2330
|
*/
|
|
1614
2331
|
listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicationReadShortResponse>>;
|
|
2332
|
+
/**
|
|
2333
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
2334
|
+
* @summary List Grants
|
|
2335
|
+
* @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
|
|
2336
|
+
* @param {*} [options] Override http request option.
|
|
2337
|
+
* @throws {RequiredError}
|
|
2338
|
+
* @memberof PublicApiInterface
|
|
2339
|
+
*/
|
|
2340
|
+
listGrantsV1AccessGrantsGet(requestParameters?: PublicApiListGrantsV1AccessGrantsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<GrantReadResponse>>;
|
|
1615
2341
|
/**
|
|
1616
2342
|
* 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
|
|
1617
2343
|
* @summary List Run Items
|
|
@@ -1630,6 +2356,24 @@ interface PublicApiInterface {
|
|
|
1630
2356
|
* @memberof PublicApiInterface
|
|
1631
2357
|
*/
|
|
1632
2358
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunReadResponse>>;
|
|
2359
|
+
/**
|
|
2360
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
2361
|
+
* @summary List Share Tokens
|
|
2362
|
+
* @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
|
|
2363
|
+
* @param {*} [options] Override http request option.
|
|
2364
|
+
* @throws {RequiredError}
|
|
2365
|
+
* @memberof PublicApiInterface
|
|
2366
|
+
*/
|
|
2367
|
+
listShareTokensV1AccessShareTokensGet(requestParameters?: PublicApiListShareTokensV1AccessShareTokensGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ShareTokenReadResponse>>;
|
|
2368
|
+
/**
|
|
2369
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
2370
|
+
* @summary List version documents
|
|
2371
|
+
* @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
|
|
2372
|
+
* @param {*} [options] Override http request option.
|
|
2373
|
+
* @throws {RequiredError}
|
|
2374
|
+
* @memberof PublicApiInterface
|
|
2375
|
+
*/
|
|
2376
|
+
listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<VersionDocumentResponse>>;
|
|
1633
2377
|
/**
|
|
1634
2378
|
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
1635
2379
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -1657,6 +2401,24 @@ interface PublicApiInterface {
|
|
|
1657
2401
|
* @memberof PublicApiInterface
|
|
1658
2402
|
*/
|
|
1659
2403
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationReadResponse>;
|
|
2404
|
+
/**
|
|
2405
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
2406
|
+
* @summary Revoke Grant
|
|
2407
|
+
* @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
|
|
2408
|
+
* @param {*} [options] Override http request option.
|
|
2409
|
+
* @throws {RequiredError}
|
|
2410
|
+
* @memberof PublicApiInterface
|
|
2411
|
+
*/
|
|
2412
|
+
revokeGrantV1AccessGrantsGrantIdDelete(requestParameters: PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<GrantReadResponse>;
|
|
2413
|
+
/**
|
|
2414
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
2415
|
+
* @summary Revoke Share Token
|
|
2416
|
+
* @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
|
|
2417
|
+
* @param {*} [options] Override http request option.
|
|
2418
|
+
* @throws {RequiredError}
|
|
2419
|
+
* @memberof PublicApiInterface
|
|
2420
|
+
*/
|
|
2421
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters: PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareTokenReadResponse>;
|
|
1660
2422
|
}
|
|
1661
2423
|
/**
|
|
1662
2424
|
* Request parameters for applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet operation in PublicApi.
|
|
@@ -1690,6 +2452,19 @@ interface PublicApiCancelRunV1RunsRunIdCancelPostRequest {
|
|
|
1690
2452
|
*/
|
|
1691
2453
|
readonly runId: string;
|
|
1692
2454
|
}
|
|
2455
|
+
/**
|
|
2456
|
+
* Request parameters for createGrantV1AccessGrantsPost operation in PublicApi.
|
|
2457
|
+
* @export
|
|
2458
|
+
* @interface PublicApiCreateGrantV1AccessGrantsPostRequest
|
|
2459
|
+
*/
|
|
2460
|
+
interface PublicApiCreateGrantV1AccessGrantsPostRequest {
|
|
2461
|
+
/**
|
|
2462
|
+
*
|
|
2463
|
+
* @type {GrantCreateRequest}
|
|
2464
|
+
* @memberof PublicApiCreateGrantV1AccessGrantsPost
|
|
2465
|
+
*/
|
|
2466
|
+
readonly grantCreateRequest: GrantCreateRequest;
|
|
2467
|
+
}
|
|
1693
2468
|
/**
|
|
1694
2469
|
* Request parameters for createRunV1RunsPost operation in PublicApi.
|
|
1695
2470
|
* @export
|
|
@@ -1703,6 +2478,19 @@ interface PublicApiCreateRunV1RunsPostRequest {
|
|
|
1703
2478
|
*/
|
|
1704
2479
|
readonly runCreationRequest: RunCreationRequest;
|
|
1705
2480
|
}
|
|
2481
|
+
/**
|
|
2482
|
+
* Request parameters for createShareTokenV1AccessShareTokensPost operation in PublicApi.
|
|
2483
|
+
* @export
|
|
2484
|
+
* @interface PublicApiCreateShareTokenV1AccessShareTokensPostRequest
|
|
2485
|
+
*/
|
|
2486
|
+
interface PublicApiCreateShareTokenV1AccessShareTokensPostRequest {
|
|
2487
|
+
/**
|
|
2488
|
+
*
|
|
2489
|
+
* @type {ShareTokenCreateRequest}
|
|
2490
|
+
* @memberof PublicApiCreateShareTokenV1AccessShareTokensPost
|
|
2491
|
+
*/
|
|
2492
|
+
readonly shareTokenCreateRequest: ShareTokenCreateRequest;
|
|
2493
|
+
}
|
|
1706
2494
|
/**
|
|
1707
2495
|
* Request parameters for deleteRunItemsV1RunsRunIdArtifactsDelete operation in PublicApi.
|
|
1708
2496
|
* @export
|
|
@@ -1734,6 +2522,25 @@ interface PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest {
|
|
|
1734
2522
|
* @memberof PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet
|
|
1735
2523
|
*/
|
|
1736
2524
|
readonly artifactId: string;
|
|
2525
|
+
/**
|
|
2526
|
+
* Share token for accessing shared runs
|
|
2527
|
+
* @type {string}
|
|
2528
|
+
* @memberof PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet
|
|
2529
|
+
*/
|
|
2530
|
+
readonly shareToken?: string | null;
|
|
2531
|
+
}
|
|
2532
|
+
/**
|
|
2533
|
+
* Request parameters for getGrantV1AccessGrantsGrantIdGet operation in PublicApi.
|
|
2534
|
+
* @export
|
|
2535
|
+
* @interface PublicApiGetGrantV1AccessGrantsGrantIdGetRequest
|
|
2536
|
+
*/
|
|
2537
|
+
interface PublicApiGetGrantV1AccessGrantsGrantIdGetRequest {
|
|
2538
|
+
/**
|
|
2539
|
+
* Grant ID
|
|
2540
|
+
* @type {string}
|
|
2541
|
+
* @memberof PublicApiGetGrantV1AccessGrantsGrantIdGet
|
|
2542
|
+
*/
|
|
2543
|
+
readonly grantId: string;
|
|
1737
2544
|
}
|
|
1738
2545
|
/**
|
|
1739
2546
|
* Request parameters for getItemByRunV1RunsRunIdItemsExternalIdGet operation in PublicApi.
|
|
@@ -1753,6 +2560,12 @@ interface PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest {
|
|
|
1753
2560
|
* @memberof PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGet
|
|
1754
2561
|
*/
|
|
1755
2562
|
readonly externalId: string;
|
|
2563
|
+
/**
|
|
2564
|
+
* Share token for accessing shared runs
|
|
2565
|
+
* @type {string}
|
|
2566
|
+
* @memberof PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGet
|
|
2567
|
+
*/
|
|
2568
|
+
readonly shareToken?: string | null;
|
|
1756
2569
|
}
|
|
1757
2570
|
/**
|
|
1758
2571
|
* Request parameters for getRunV1RunsRunIdGet operation in PublicApi.
|
|
@@ -1766,6 +2579,100 @@ interface PublicApiGetRunV1RunsRunIdGetRequest {
|
|
|
1766
2579
|
* @memberof PublicApiGetRunV1RunsRunIdGet
|
|
1767
2580
|
*/
|
|
1768
2581
|
readonly runId: string;
|
|
2582
|
+
/**
|
|
2583
|
+
* Share token for accessing shared runs
|
|
2584
|
+
* @type {string}
|
|
2585
|
+
* @memberof PublicApiGetRunV1RunsRunIdGet
|
|
2586
|
+
*/
|
|
2587
|
+
readonly shareToken?: string | null;
|
|
2588
|
+
}
|
|
2589
|
+
/**
|
|
2590
|
+
* Request parameters for getShareTokenV1AccessShareTokensShareTokenIdGet operation in PublicApi.
|
|
2591
|
+
* @export
|
|
2592
|
+
* @interface PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest
|
|
2593
|
+
*/
|
|
2594
|
+
interface PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest {
|
|
2595
|
+
/**
|
|
2596
|
+
* Share token ID
|
|
2597
|
+
* @type {string}
|
|
2598
|
+
* @memberof PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGet
|
|
2599
|
+
*/
|
|
2600
|
+
readonly shareTokenId: string;
|
|
2601
|
+
}
|
|
2602
|
+
/**
|
|
2603
|
+
* Request parameters for getVersionDocument operation in PublicApi.
|
|
2604
|
+
* @export
|
|
2605
|
+
* @interface PublicApiGetVersionDocumentRequest
|
|
2606
|
+
*/
|
|
2607
|
+
interface PublicApiGetVersionDocumentRequest {
|
|
2608
|
+
/**
|
|
2609
|
+
*
|
|
2610
|
+
* @type {string}
|
|
2611
|
+
* @memberof PublicApiGetVersionDocument
|
|
2612
|
+
*/
|
|
2613
|
+
readonly applicationId: string;
|
|
2614
|
+
/**
|
|
2615
|
+
*
|
|
2616
|
+
* @type {string}
|
|
2617
|
+
* @memberof PublicApiGetVersionDocument
|
|
2618
|
+
*/
|
|
2619
|
+
readonly version: string;
|
|
2620
|
+
/**
|
|
2621
|
+
*
|
|
2622
|
+
* @type {string}
|
|
2623
|
+
* @memberof PublicApiGetVersionDocument
|
|
2624
|
+
*/
|
|
2625
|
+
readonly name: string;
|
|
2626
|
+
}
|
|
2627
|
+
/**
|
|
2628
|
+
* Request parameters for getVersionDocumentContent operation in PublicApi.
|
|
2629
|
+
* @export
|
|
2630
|
+
* @interface PublicApiGetVersionDocumentContentRequest
|
|
2631
|
+
*/
|
|
2632
|
+
interface PublicApiGetVersionDocumentContentRequest {
|
|
2633
|
+
/**
|
|
2634
|
+
*
|
|
2635
|
+
* @type {string}
|
|
2636
|
+
* @memberof PublicApiGetVersionDocumentContent
|
|
2637
|
+
*/
|
|
2638
|
+
readonly applicationId: string;
|
|
2639
|
+
/**
|
|
2640
|
+
*
|
|
2641
|
+
* @type {string}
|
|
2642
|
+
* @memberof PublicApiGetVersionDocumentContent
|
|
2643
|
+
*/
|
|
2644
|
+
readonly version: string;
|
|
2645
|
+
/**
|
|
2646
|
+
*
|
|
2647
|
+
* @type {string}
|
|
2648
|
+
* @memberof PublicApiGetVersionDocumentContent
|
|
2649
|
+
*/
|
|
2650
|
+
readonly name: string;
|
|
2651
|
+
}
|
|
2652
|
+
/**
|
|
2653
|
+
* Request parameters for getVersionDocumentFile operation in PublicApi.
|
|
2654
|
+
* @export
|
|
2655
|
+
* @interface PublicApiGetVersionDocumentFileRequest
|
|
2656
|
+
*/
|
|
2657
|
+
interface PublicApiGetVersionDocumentFileRequest {
|
|
2658
|
+
/**
|
|
2659
|
+
*
|
|
2660
|
+
* @type {string}
|
|
2661
|
+
* @memberof PublicApiGetVersionDocumentFile
|
|
2662
|
+
*/
|
|
2663
|
+
readonly applicationId: string;
|
|
2664
|
+
/**
|
|
2665
|
+
*
|
|
2666
|
+
* @type {string}
|
|
2667
|
+
* @memberof PublicApiGetVersionDocumentFile
|
|
2668
|
+
*/
|
|
2669
|
+
readonly version: string;
|
|
2670
|
+
/**
|
|
2671
|
+
*
|
|
2672
|
+
* @type {string}
|
|
2673
|
+
* @memberof PublicApiGetVersionDocumentFile
|
|
2674
|
+
*/
|
|
2675
|
+
readonly name: string;
|
|
1769
2676
|
}
|
|
1770
2677
|
/**
|
|
1771
2678
|
* Request parameters for listApplicationsV1ApplicationsGet operation in PublicApi.
|
|
@@ -1792,6 +2699,61 @@ interface PublicApiListApplicationsV1ApplicationsGetRequest {
|
|
|
1792
2699
|
*/
|
|
1793
2700
|
readonly sort?: Array<string> | null;
|
|
1794
2701
|
}
|
|
2702
|
+
/**
|
|
2703
|
+
* Request parameters for listGrantsV1AccessGrantsGet operation in PublicApi.
|
|
2704
|
+
* @export
|
|
2705
|
+
* @interface PublicApiListGrantsV1AccessGrantsGetRequest
|
|
2706
|
+
*/
|
|
2707
|
+
interface PublicApiListGrantsV1AccessGrantsGetRequest {
|
|
2708
|
+
/**
|
|
2709
|
+
*
|
|
2710
|
+
* @type {ResourceType}
|
|
2711
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2712
|
+
*/
|
|
2713
|
+
readonly resourceType?: ResourceType | null;
|
|
2714
|
+
/**
|
|
2715
|
+
*
|
|
2716
|
+
* @type {string}
|
|
2717
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2718
|
+
*/
|
|
2719
|
+
readonly resourceId?: string | null;
|
|
2720
|
+
/**
|
|
2721
|
+
*
|
|
2722
|
+
* @type {SubjectType}
|
|
2723
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2724
|
+
*/
|
|
2725
|
+
readonly subjectType?: SubjectType | null;
|
|
2726
|
+
/**
|
|
2727
|
+
*
|
|
2728
|
+
* @type {string}
|
|
2729
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2730
|
+
*/
|
|
2731
|
+
readonly subjectId?: string | null;
|
|
2732
|
+
/**
|
|
2733
|
+
*
|
|
2734
|
+
* @type {boolean}
|
|
2735
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2736
|
+
*/
|
|
2737
|
+
readonly revoked?: boolean | null;
|
|
2738
|
+
/**
|
|
2739
|
+
*
|
|
2740
|
+
* @type {number}
|
|
2741
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2742
|
+
*/
|
|
2743
|
+
readonly page?: number;
|
|
2744
|
+
/**
|
|
2745
|
+
*
|
|
2746
|
+
* @type {number}
|
|
2747
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2748
|
+
*/
|
|
2749
|
+
readonly pageSize?: number;
|
|
2750
|
+
/**
|
|
2751
|
+
* Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
2752
|
+
* @type {Array<string>}
|
|
2753
|
+
* @memberof PublicApiListGrantsV1AccessGrantsGet
|
|
2754
|
+
*/
|
|
2755
|
+
readonly sort?: Array<string> | null;
|
|
2756
|
+
}
|
|
1795
2757
|
/**
|
|
1796
2758
|
* Request parameters for listRunItemsV1RunsRunIdItemsGet operation in PublicApi.
|
|
1797
2759
|
* @export
|
|
@@ -1804,6 +2766,12 @@ interface PublicApiListRunItemsV1RunsRunIdItemsGetRequest {
|
|
|
1804
2766
|
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
1805
2767
|
*/
|
|
1806
2768
|
readonly runId: string;
|
|
2769
|
+
/**
|
|
2770
|
+
* Share token for accessing shared runs
|
|
2771
|
+
* @type {string}
|
|
2772
|
+
* @memberof PublicApiListRunItemsV1RunsRunIdItemsGet
|
|
2773
|
+
*/
|
|
2774
|
+
readonly shareToken?: string | null;
|
|
1807
2775
|
/**
|
|
1808
2776
|
* Filter for item ids
|
|
1809
2777
|
* @type {Array<string>}
|
|
@@ -1908,6 +2876,68 @@ interface PublicApiListRunsV1RunsGetRequest {
|
|
|
1908
2876
|
*/
|
|
1909
2877
|
readonly sort?: Array<string> | null;
|
|
1910
2878
|
}
|
|
2879
|
+
/**
|
|
2880
|
+
* Request parameters for listShareTokensV1AccessShareTokensGet operation in PublicApi.
|
|
2881
|
+
* @export
|
|
2882
|
+
* @interface PublicApiListShareTokensV1AccessShareTokensGetRequest
|
|
2883
|
+
*/
|
|
2884
|
+
interface PublicApiListShareTokensV1AccessShareTokensGetRequest {
|
|
2885
|
+
/**
|
|
2886
|
+
* Filter by run ID
|
|
2887
|
+
* @type {string}
|
|
2888
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2889
|
+
*/
|
|
2890
|
+
readonly runId?: string | null;
|
|
2891
|
+
/**
|
|
2892
|
+
* Filter by share token creator
|
|
2893
|
+
* @type {string}
|
|
2894
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2895
|
+
*/
|
|
2896
|
+
readonly createdBy?: string | null;
|
|
2897
|
+
/**
|
|
2898
|
+
*
|
|
2899
|
+
* @type {boolean}
|
|
2900
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2901
|
+
*/
|
|
2902
|
+
readonly revoked?: boolean | null;
|
|
2903
|
+
/**
|
|
2904
|
+
*
|
|
2905
|
+
* @type {number}
|
|
2906
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2907
|
+
*/
|
|
2908
|
+
readonly page?: number;
|
|
2909
|
+
/**
|
|
2910
|
+
*
|
|
2911
|
+
* @type {number}
|
|
2912
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2913
|
+
*/
|
|
2914
|
+
readonly pageSize?: number;
|
|
2915
|
+
/**
|
|
2916
|
+
* Sort the results by one or more fields. Use `+` for ascending and `-` for descending order.
|
|
2917
|
+
* @type {Array<string>}
|
|
2918
|
+
* @memberof PublicApiListShareTokensV1AccessShareTokensGet
|
|
2919
|
+
*/
|
|
2920
|
+
readonly sort?: Array<string> | null;
|
|
2921
|
+
}
|
|
2922
|
+
/**
|
|
2923
|
+
* Request parameters for listVersionDocuments operation in PublicApi.
|
|
2924
|
+
* @export
|
|
2925
|
+
* @interface PublicApiListVersionDocumentsRequest
|
|
2926
|
+
*/
|
|
2927
|
+
interface PublicApiListVersionDocumentsRequest {
|
|
2928
|
+
/**
|
|
2929
|
+
*
|
|
2930
|
+
* @type {string}
|
|
2931
|
+
* @memberof PublicApiListVersionDocuments
|
|
2932
|
+
*/
|
|
2933
|
+
readonly applicationId: string;
|
|
2934
|
+
/**
|
|
2935
|
+
*
|
|
2936
|
+
* @type {string}
|
|
2937
|
+
* @memberof PublicApiListVersionDocuments
|
|
2938
|
+
*/
|
|
2939
|
+
readonly version: string;
|
|
2940
|
+
}
|
|
1911
2941
|
/**
|
|
1912
2942
|
* Request parameters for putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut operation in PublicApi.
|
|
1913
2943
|
* @export
|
|
@@ -1965,6 +2995,32 @@ interface PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest {
|
|
|
1965
2995
|
*/
|
|
1966
2996
|
readonly applicationId: string;
|
|
1967
2997
|
}
|
|
2998
|
+
/**
|
|
2999
|
+
* Request parameters for revokeGrantV1AccessGrantsGrantIdDelete operation in PublicApi.
|
|
3000
|
+
* @export
|
|
3001
|
+
* @interface PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest
|
|
3002
|
+
*/
|
|
3003
|
+
interface PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest {
|
|
3004
|
+
/**
|
|
3005
|
+
* Grant ID
|
|
3006
|
+
* @type {string}
|
|
3007
|
+
* @memberof PublicApiRevokeGrantV1AccessGrantsGrantIdDelete
|
|
3008
|
+
*/
|
|
3009
|
+
readonly grantId: string;
|
|
3010
|
+
}
|
|
3011
|
+
/**
|
|
3012
|
+
* Request parameters for revokeShareTokenV1AccessShareTokensShareTokenIdDelete operation in PublicApi.
|
|
3013
|
+
* @export
|
|
3014
|
+
* @interface PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest
|
|
3015
|
+
*/
|
|
3016
|
+
interface PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest {
|
|
3017
|
+
/**
|
|
3018
|
+
* Share token ID
|
|
3019
|
+
* @type {string}
|
|
3020
|
+
* @memberof PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDelete
|
|
3021
|
+
*/
|
|
3022
|
+
readonly shareTokenId: string;
|
|
3023
|
+
}
|
|
1968
3024
|
/**
|
|
1969
3025
|
* PublicApi - object-oriented interface
|
|
1970
3026
|
* @export
|
|
@@ -1990,6 +3046,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
1990
3046
|
* @memberof PublicApi
|
|
1991
3047
|
*/
|
|
1992
3048
|
cancelRunV1RunsRunIdCancelPost(requestParameters: PublicApiCancelRunV1RunsRunIdCancelPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
3049
|
+
/**
|
|
3050
|
+
* Create a grant to share access to a resource with a subject (user or organization).
|
|
3051
|
+
* @summary Create Grant
|
|
3052
|
+
* @param {PublicApiCreateGrantV1AccessGrantsPostRequest} requestParameters Request parameters.
|
|
3053
|
+
* @param {*} [options] Override http request option.
|
|
3054
|
+
* @throws {RequiredError}
|
|
3055
|
+
* @memberof PublicApi
|
|
3056
|
+
*/
|
|
3057
|
+
createGrantV1AccessGrantsPost(requestParameters: PublicApiCreateGrantV1AccessGrantsPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse, any, {}>>;
|
|
1993
3058
|
/**
|
|
1994
3059
|
* 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
|
|
1995
3060
|
* @summary Initiate Run
|
|
@@ -1999,6 +3064,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
1999
3064
|
* @memberof PublicApi
|
|
2000
3065
|
*/
|
|
2001
3066
|
createRunV1RunsPost(requestParameters: PublicApiCreateRunV1RunsPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunCreationResponse, any, {}>>;
|
|
3067
|
+
/**
|
|
3068
|
+
* 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.
|
|
3069
|
+
* @summary Create Share Token
|
|
3070
|
+
* @param {PublicApiCreateShareTokenV1AccessShareTokensPostRequest} requestParameters Request parameters.
|
|
3071
|
+
* @param {*} [options] Override http request option.
|
|
3072
|
+
* @throws {RequiredError}
|
|
3073
|
+
* @memberof PublicApi
|
|
3074
|
+
*/
|
|
3075
|
+
createShareTokenV1AccessShareTokensPost(requestParameters: PublicApiCreateShareTokenV1AccessShareTokensPostRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenCreateResponse, any, {}>>;
|
|
2002
3076
|
/**
|
|
2003
3077
|
* 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.
|
|
2004
3078
|
* @summary Delete Run Items
|
|
@@ -2017,6 +3091,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2017
3091
|
* @memberof PublicApi
|
|
2018
3092
|
*/
|
|
2019
3093
|
getArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGet(requestParameters: PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
|
|
3094
|
+
/**
|
|
3095
|
+
* Get a grant by its ID.
|
|
3096
|
+
* @summary Get Grant
|
|
3097
|
+
* @param {PublicApiGetGrantV1AccessGrantsGrantIdGetRequest} requestParameters Request parameters.
|
|
3098
|
+
* @param {*} [options] Override http request option.
|
|
3099
|
+
* @throws {RequiredError}
|
|
3100
|
+
* @memberof PublicApi
|
|
3101
|
+
*/
|
|
3102
|
+
getGrantV1AccessGrantsGrantIdGet(requestParameters: PublicApiGetGrantV1AccessGrantsGrantIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse, any, {}>>;
|
|
2020
3103
|
/**
|
|
2021
3104
|
* Retrieve details of a specific item (slide) by its external ID and the run ID.
|
|
2022
3105
|
* @summary Get Item By Run
|
|
@@ -2035,7 +3118,7 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2035
3118
|
*/
|
|
2036
3119
|
getMeV1MeGet(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<MeReadResponse, any, {}>>;
|
|
2037
3120
|
/**
|
|
2038
|
-
* 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.
|
|
3121
|
+
* 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.
|
|
2039
3122
|
* @summary Get run details
|
|
2040
3123
|
* @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
|
|
2041
3124
|
* @param {*} [options] Override http request option.
|
|
@@ -2043,6 +3126,42 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2043
3126
|
* @memberof PublicApi
|
|
2044
3127
|
*/
|
|
2045
3128
|
getRunV1RunsRunIdGet(requestParameters: PublicApiGetRunV1RunsRunIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse, any, {}>>;
|
|
3129
|
+
/**
|
|
3130
|
+
* Get a share token by its ID.
|
|
3131
|
+
* @summary Get Share Token
|
|
3132
|
+
* @param {PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest} requestParameters Request parameters.
|
|
3133
|
+
* @param {*} [options] Override http request option.
|
|
3134
|
+
* @throws {RequiredError}
|
|
3135
|
+
* @memberof PublicApi
|
|
3136
|
+
*/
|
|
3137
|
+
getShareTokenV1AccessShareTokensShareTokenIdGet(requestParameters: PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenReadResponse, any, {}>>;
|
|
3138
|
+
/**
|
|
3139
|
+
* Return metadata for a single public document attached to an application version.
|
|
3140
|
+
* @summary Get version document metadata
|
|
3141
|
+
* @param {PublicApiGetVersionDocumentRequest} requestParameters Request parameters.
|
|
3142
|
+
* @param {*} [options] Override http request option.
|
|
3143
|
+
* @throws {RequiredError}
|
|
3144
|
+
* @memberof PublicApi
|
|
3145
|
+
*/
|
|
3146
|
+
getVersionDocument(requestParameters: PublicApiGetVersionDocumentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionDocumentResponse, any, {}>>;
|
|
3147
|
+
/**
|
|
3148
|
+
* 307 redirect to a short-lived GCS signed URL for streaming document content. Unlike ``/file``, no ``Content-Disposition`` override is set — GCS serves the object body with its stored ``Content-Type``. Intended for programmatic clients that follow redirects and consume the content directly. Response carries ``Cache-Control: no-store``.
|
|
3149
|
+
* @summary Stream version document content (programmatic)
|
|
3150
|
+
* @param {PublicApiGetVersionDocumentContentRequest} requestParameters Request parameters.
|
|
3151
|
+
* @param {*} [options] Override http request option.
|
|
3152
|
+
* @throws {RequiredError}
|
|
3153
|
+
* @memberof PublicApi
|
|
3154
|
+
*/
|
|
3155
|
+
getVersionDocumentContent(requestParameters: PublicApiGetVersionDocumentContentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
|
|
3156
|
+
/**
|
|
3157
|
+
* 307 redirect to a short-lived GCS signed URL for downloading a document. The signed URL includes ``response-content-disposition=attachment; filename=\"<name>\"`` so browsers prompt a save-as dialog rather than rendering inline. Response carries ``Cache-Control: no-store``.
|
|
3158
|
+
* @summary Download version document (browser)
|
|
3159
|
+
* @param {PublicApiGetVersionDocumentFileRequest} requestParameters Request parameters.
|
|
3160
|
+
* @param {*} [options] Override http request option.
|
|
3161
|
+
* @throws {RequiredError}
|
|
3162
|
+
* @memberof PublicApi
|
|
3163
|
+
*/
|
|
3164
|
+
getVersionDocumentFile(requestParameters: PublicApiGetVersionDocumentFileRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
|
|
2046
3165
|
/**
|
|
2047
3166
|
* Returns the list of the applications, available to the caller. The application is available if any of the versions of the application is assigned to the caller\'s organization. The response is paginated and sorted according to the provided parameters.
|
|
2048
3167
|
* @summary List available applications
|
|
@@ -2052,6 +3171,15 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2052
3171
|
* @memberof PublicApi
|
|
2053
3172
|
*/
|
|
2054
3173
|
listApplicationsV1ApplicationsGet(requestParameters?: PublicApiListApplicationsV1ApplicationsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadShortResponse[], any, {}>>;
|
|
3174
|
+
/**
|
|
3175
|
+
* List grants. Org admins see all grants for all resources in their organization. Regular users see grants for all resources they submitted.
|
|
3176
|
+
* @summary List Grants
|
|
3177
|
+
* @param {PublicApiListGrantsV1AccessGrantsGetRequest} requestParameters Request parameters.
|
|
3178
|
+
* @param {*} [options] Override http request option.
|
|
3179
|
+
* @throws {RequiredError}
|
|
3180
|
+
* @memberof PublicApi
|
|
3181
|
+
*/
|
|
3182
|
+
listGrantsV1AccessGrantsGet(requestParameters?: PublicApiListGrantsV1AccessGrantsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse[], any, {}>>;
|
|
2055
3183
|
/**
|
|
2056
3184
|
* 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
|
|
2057
3185
|
* @summary List Run Items
|
|
@@ -2070,6 +3198,24 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2070
3198
|
* @memberof PublicApi
|
|
2071
3199
|
*/
|
|
2072
3200
|
listRunsV1RunsGet(requestParameters?: PublicApiListRunsV1RunsGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RunReadResponse[], any, {}>>;
|
|
3201
|
+
/**
|
|
3202
|
+
* List share tokens. Service and Superadmin see all tokens; other users see only their own.
|
|
3203
|
+
* @summary List Share Tokens
|
|
3204
|
+
* @param {PublicApiListShareTokensV1AccessShareTokensGetRequest} requestParameters Request parameters.
|
|
3205
|
+
* @param {*} [options] Override http request option.
|
|
3206
|
+
* @throws {RequiredError}
|
|
3207
|
+
* @memberof PublicApi
|
|
3208
|
+
*/
|
|
3209
|
+
listShareTokensV1AccessShareTokensGet(requestParameters?: PublicApiListShareTokensV1AccessShareTokensGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenReadResponse[], any, {}>>;
|
|
3210
|
+
/**
|
|
3211
|
+
* List public documents attached to an application version. Returns only documents with ``visibility=public`` and ``status=uploaded``.
|
|
3212
|
+
* @summary List version documents
|
|
3213
|
+
* @param {PublicApiListVersionDocumentsRequest} requestParameters Request parameters.
|
|
3214
|
+
* @param {*} [options] Override http request option.
|
|
3215
|
+
* @throws {RequiredError}
|
|
3216
|
+
* @memberof PublicApi
|
|
3217
|
+
*/
|
|
3218
|
+
listVersionDocuments(requestParameters: PublicApiListVersionDocumentsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<VersionDocumentResponse[], any, {}>>;
|
|
2073
3219
|
/**
|
|
2074
3220
|
* Update the custom metadata of the item with the specified `external_id`, belonging to the specified run. Optionally, a checksum may be provided along the custom metadata JSON. It can be used to verify if the custom metadata was updated since the last time it was accessed. If the checksum is provided, it must match the existing custom metadata in the system, ensuring that the current custom metadata value to be overwritten is acknowledged by the user. If no checksum is provided, submitted metadata directly overwrites the existing metadata, without any checks. The latest custom metadata and checksum can be retrieved for individual items via `GET /v1/runs/{run_id}/items/{external_id}`, and for all items of a run via `GET /v1/runs/{run_id}/items`.
|
|
2075
3221
|
* @summary Put Item Custom Metadata By Run
|
|
@@ -2097,6 +3243,24 @@ declare class PublicApi extends BaseAPI implements PublicApiInterface {
|
|
|
2097
3243
|
* @memberof PublicApi
|
|
2098
3244
|
*/
|
|
2099
3245
|
readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters: PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ApplicationReadResponse, any, {}>>;
|
|
3246
|
+
/**
|
|
3247
|
+
* Revoke a grant by its ID. Sets the revoked_at timestamp on the grant.
|
|
3248
|
+
* @summary Revoke Grant
|
|
3249
|
+
* @param {PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest} requestParameters Request parameters.
|
|
3250
|
+
* @param {*} [options] Override http request option.
|
|
3251
|
+
* @throws {RequiredError}
|
|
3252
|
+
* @memberof PublicApi
|
|
3253
|
+
*/
|
|
3254
|
+
revokeGrantV1AccessGrantsGrantIdDelete(requestParameters: PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GrantReadResponse, any, {}>>;
|
|
3255
|
+
/**
|
|
3256
|
+
* Revoke a share token by its ID. Invalidates the credential regardless of any active grants.
|
|
3257
|
+
* @summary Revoke Share Token
|
|
3258
|
+
* @param {PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest} requestParameters Request parameters.
|
|
3259
|
+
* @param {*} [options] Override http request option.
|
|
3260
|
+
* @throws {RequiredError}
|
|
3261
|
+
* @memberof PublicApi
|
|
3262
|
+
*/
|
|
3263
|
+
revokeShareTokenV1AccessShareTokensShareTokenIdDelete(requestParameters: PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShareTokenReadResponse, any, {}>>;
|
|
2100
3264
|
}
|
|
2101
3265
|
|
|
2102
|
-
export { type
|
|
3266
|
+
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 };
|