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