@aignostics/sdk 2.3.1 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs CHANGED
@@ -13,7 +13,7 @@ var z__default = /*#__PURE__*/_interopDefault(z);
13
13
  // package.json
14
14
  var package_default = {
15
15
  version: "0.0.0-development"};
16
- var BASE_PATH = "https://raw.githubusercontent.com/api".replace(/\/+$/, "");
16
+ var BASE_PATH = "https://platform-staging.aignostics.com/api".replace(/\/+$/, "");
17
17
  var BaseAPI = class {
18
18
  constructor(configuration, basePath = BASE_PATH, axios = globalAxios2__default.default) {
19
19
  this.basePath = basePath;
@@ -86,40 +86,102 @@ var createRequestFunction = function(axiosArgs, globalAxios3, BASE_PATH2, config
86
86
  };
87
87
 
88
88
  // src/generated/api.ts
89
- var ApplicationRunStatus = {
90
- CanceledSystem: "CANCELED_SYSTEM",
91
- CanceledUser: "CANCELED_USER",
92
- Completed: "COMPLETED",
93
- CompletedWithError: "COMPLETED_WITH_ERROR",
94
- Received: "RECEIVED",
95
- Rejected: "REJECTED",
96
- Running: "RUNNING",
97
- Scheduled: "SCHEDULED"
89
+ var ArtifactOutput = {
90
+ None: "NONE",
91
+ Available: "AVAILABLE",
92
+ DeletedByUser: "DELETED_BY_USER",
93
+ DeletedBySystem: "DELETED_BY_SYSTEM"
98
94
  };
99
- var ItemStatus = {
95
+ var ArtifactState = {
100
96
  Pending: "PENDING",
101
- CanceledUser: "CANCELED_USER",
102
- CanceledSystem: "CANCELED_SYSTEM",
103
- ErrorUser: "ERROR_USER",
104
- ErrorSystem: "ERROR_SYSTEM",
105
- Succeeded: "SUCCEEDED"
97
+ Processing: "PROCESSING",
98
+ Terminated: "TERMINATED"
99
+ };
100
+ var ArtifactTerminationReason = {
101
+ Succeeded: "SUCCEEDED",
102
+ UserError: "USER_ERROR",
103
+ SystemError: "SYSTEM_ERROR",
104
+ Skipped: "SKIPPED"
105
+ };
106
+ var ItemOutput = {
107
+ None: "NONE",
108
+ Full: "FULL"
109
+ };
110
+ var ItemState = {
111
+ Pending: "PENDING",
112
+ Processing: "PROCESSING",
113
+ Terminated: "TERMINATED"
114
+ };
115
+ var ItemTerminationReason = {
116
+ Succeeded: "SUCCEEDED",
117
+ UserError: "USER_ERROR",
118
+ SystemError: "SYSTEM_ERROR",
119
+ Skipped: "SKIPPED"
106
120
  };
107
121
  var OutputArtifactScope = {
108
122
  Item: "ITEM",
109
123
  Global: "GLOBAL"
110
124
  };
125
+ var OutputArtifactVisibility = {
126
+ Internal: "INTERNAL",
127
+ External: "EXTERNAL"
128
+ };
129
+ var RunOutput = {
130
+ None: "NONE",
131
+ Partial: "PARTIAL",
132
+ Full: "FULL"
133
+ };
134
+ var RunState = {
135
+ Pending: "PENDING",
136
+ Processing: "PROCESSING",
137
+ Terminated: "TERMINATED"
138
+ };
139
+ var RunTerminationReason = {
140
+ AllItemsProcessed: "ALL_ITEMS_PROCESSED",
141
+ CanceledBySystem: "CANCELED_BY_SYSTEM",
142
+ CanceledByUser: "CANCELED_BY_USER"
143
+ };
111
144
  var PublicApiAxiosParamCreator = function(configuration) {
112
145
  return {
113
146
  /**
114
- * The application run can be canceled by the user who created the application run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
115
- * @summary Cancel Application Run
116
- * @param {string} applicationRunId Application run id, returned by `POST /runs/` endpoint
147
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
148
+ * @summary Application Version Details
149
+ * @param {string} applicationId
150
+ * @param {string} version
151
+ * @param {*} [options] Override http request option.
152
+ * @throws {RequiredError}
153
+ */
154
+ applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet: async (applicationId, version, options = {}) => {
155
+ assertParamExists("applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet", "applicationId", applicationId);
156
+ assertParamExists("applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet", "version", version);
157
+ const localVarPath = `/v1/applications/{application_id}/versions/{version}`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId))).replace(`{${"version"}}`, encodeURIComponent(String(version)));
158
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
159
+ let baseOptions;
160
+ if (configuration) {
161
+ baseOptions = configuration.baseOptions;
162
+ }
163
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
164
+ const localVarHeaderParameter = {};
165
+ const localVarQueryParameter = {};
166
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
167
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
168
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
169
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
170
+ return {
171
+ url: toPathString(localVarUrlObj),
172
+ options: localVarRequestOptions
173
+ };
174
+ },
175
+ /**
176
+ * 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.
177
+ * @summary Cancel Run
178
+ * @param {string} runId Run id, returned by `POST /runs/` endpoint
117
179
  * @param {*} [options] Override http request option.
118
180
  * @throws {RequiredError}
119
181
  */
120
- cancelApplicationRunV1RunsApplicationRunIdCancelPost: async (applicationRunId, options = {}) => {
121
- assertParamExists("cancelApplicationRunV1RunsApplicationRunIdCancelPost", "applicationRunId", applicationRunId);
122
- const localVarPath = `/v1/runs/{application_run_id}/cancel`.replace(`{${"application_run_id"}}`, encodeURIComponent(String(applicationRunId)));
182
+ cancelRunV1RunsRunIdCancelPost: async (runId, options = {}) => {
183
+ assertParamExists("cancelRunV1RunsRunIdCancelPost", "runId", runId);
184
+ const localVarPath = `/v1/runs/{run_id}/cancel`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
123
185
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
124
186
  let baseOptions;
125
187
  if (configuration) {
@@ -138,14 +200,14 @@ var PublicApiAxiosParamCreator = function(configuration) {
138
200
  };
139
201
  },
140
202
  /**
141
- * The endpoint is used to process the input items by the chosen application version. The endpoint returns the `application_run_id`. The processing fo the items is done asynchronously. To check the status or cancel the execution, use the /v1/runs/{application_run_id} endpoint. ### Payload The payload includes `application_version_id` and `items` base fields. `application_version_id` is the id used for `/v1/versions/{application_id}` endpoint. `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 metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_version_id: \"test-app:v0.0.2\", items: [{ \"reference\": \"slide_1\", <-- Input ID to connect the input and the output artifact \"input_artifacts\": [{ \"name\": \"input_slide\", <-- Name of the artifact defined by the application (For HETA it is\"input_slide\") \"download_url\": \"https://...\", <-- signed URL to the input file in the S3 or GCS. Should be valid for more than 6 days \"metadata\": { <-- The metadata fields defined by the application. (The example fields set for a slide files are provided) \"checksum_base64_crc32c\": \"abc12==\", \"mime_type\": \"image/tiff\", \"height\": 100, \"weight\": 500, \"mpp\": 0.543 } }] }] } ``` ### Response The endpoint returns the application run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{application_run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
142
- * @summary Create Application Run
203
+ * 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
204
+ * @summary Initiate Run
143
205
  * @param {RunCreationRequest} runCreationRequest
144
206
  * @param {*} [options] Override http request option.
145
207
  * @throws {RequiredError}
146
208
  */
147
- createApplicationRunV1RunsPost: async (runCreationRequest, options = {}) => {
148
- assertParamExists("createApplicationRunV1RunsPost", "runCreationRequest", runCreationRequest);
209
+ createRunV1RunsPost: async (runCreationRequest, options = {}) => {
210
+ assertParamExists("createRunV1RunsPost", "runCreationRequest", runCreationRequest);
149
211
  const localVarPath = `/v1/runs`;
150
212
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
151
213
  let baseOptions;
@@ -167,15 +229,15 @@ var PublicApiAxiosParamCreator = function(configuration) {
167
229
  };
168
230
  },
169
231
  /**
170
- * Delete the application run results. It can only be called when the application is in a final state (meaning it\'s not in `received` or `pending` states). To delete the results of the running artifacts, first call `POST /v1/runs/{application_run_id}/cancel` to cancel the application run. The output results are deleted automatically 30 days after the application run is finished.
171
- * @summary Delete Application Run Results
172
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
232
+ * 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.
233
+ * @summary Delete Run Items
234
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
173
235
  * @param {*} [options] Override http request option.
174
236
  * @throws {RequiredError}
175
237
  */
176
- deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete: async (applicationRunId, options = {}) => {
177
- assertParamExists("deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete", "applicationRunId", applicationRunId);
178
- const localVarPath = `/v1/runs/{application_run_id}/results`.replace(`{${"application_run_id"}}`, encodeURIComponent(String(applicationRunId)));
238
+ deleteRunItemsV1RunsRunIdArtifactsDelete: async (runId, options = {}) => {
239
+ assertParamExists("deleteRunItemsV1RunsRunIdArtifactsDelete", "runId", runId);
240
+ const localVarPath = `/v1/runs/{run_id}/artifacts`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
179
241
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
180
242
  let baseOptions;
181
243
  if (configuration) {
@@ -194,13 +256,17 @@ var PublicApiAxiosParamCreator = function(configuration) {
194
256
  };
195
257
  },
196
258
  /**
197
- *
198
- * @summary Get Me
259
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
260
+ * @summary Get Item By Run
261
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
262
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
199
263
  * @param {*} [options] Override http request option.
200
264
  * @throws {RequiredError}
201
265
  */
202
- getMeV1MeGet: async (options = {}) => {
203
- const localVarPath = `/v1/me`;
266
+ getItemByRunV1RunsRunIdItemsExternalIdGet: async (runId, externalId, options = {}) => {
267
+ assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "runId", runId);
268
+ assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "externalId", externalId);
269
+ const localVarPath = `/v1/runs/{run_id}/items/{external_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"external_id"}}`, encodeURIComponent(String(externalId)));
204
270
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
205
271
  let baseOptions;
206
272
  if (configuration) {
@@ -219,16 +285,13 @@ var PublicApiAxiosParamCreator = function(configuration) {
219
285
  };
220
286
  },
221
287
  /**
222
- * Returns the details of the application run. The application run is available as soon as it is created via `POST /runs/` endpoint. To download the items results, call `/runs/{application_run_id}/results`. The application is only available to the user who triggered it, regardless of the role.
223
- * @summary Get Run
224
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
225
- * @param {Array<any> | null} [include]
288
+ * 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)
289
+ * @summary Get current user
226
290
  * @param {*} [options] Override http request option.
227
291
  * @throws {RequiredError}
228
292
  */
229
- getRunV1RunsApplicationRunIdGet: async (applicationRunId, include, options = {}) => {
230
- assertParamExists("getRunV1RunsApplicationRunIdGet", "applicationRunId", applicationRunId);
231
- const localVarPath = `/v1/runs/{application_run_id}`.replace(`{${"application_run_id"}}`, encodeURIComponent(String(applicationRunId)));
293
+ getMeV1MeGet: async (options = {}) => {
294
+ const localVarPath = `/v1/me`;
232
295
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
233
296
  let baseOptions;
234
297
  if (configuration) {
@@ -238,9 +301,6 @@ var PublicApiAxiosParamCreator = function(configuration) {
238
301
  const localVarHeaderParameter = {};
239
302
  const localVarQueryParameter = {};
240
303
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
241
- if (include) {
242
- localVarQueryParameter["include"] = include;
243
- }
244
304
  setSearchParams(localVarUrlObj, localVarQueryParameter);
245
305
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
246
306
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -250,19 +310,15 @@ var PublicApiAxiosParamCreator = function(configuration) {
250
310
  };
251
311
  },
252
312
  /**
253
- * The endpoint returns the application runs triggered by the caller. After the application run is created by POST /v1/runs, it becomes available for the current endpoint
254
- * @summary List Application Runs
255
- * @param {string | null} [applicationId] Optional application ID filter
256
- * @param {string | null} [applicationVersion] Optional application version filter
257
- * @param {Array<any> | null} [include] Request optional output values. Used internally by the platform
258
- * @param {number} [page]
259
- * @param {number} [pageSize]
260
- * @param {Array<string> | null} [sort]
313
+ * 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.
314
+ * @summary Get run details
315
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
261
316
  * @param {*} [options] Override http request option.
262
317
  * @throws {RequiredError}
263
318
  */
264
- listApplicationRunsV1RunsGet: async (applicationId, applicationVersion, include, page, pageSize, sort, options = {}) => {
265
- const localVarPath = `/v1/runs`;
319
+ getRunV1RunsRunIdGet: async (runId, options = {}) => {
320
+ assertParamExists("getRunV1RunsRunIdGet", "runId", runId);
321
+ const localVarPath = `/v1/runs/{run_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
266
322
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
267
323
  let baseOptions;
268
324
  if (configuration) {
@@ -272,24 +328,6 @@ var PublicApiAxiosParamCreator = function(configuration) {
272
328
  const localVarHeaderParameter = {};
273
329
  const localVarQueryParameter = {};
274
330
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
275
- if (applicationId !== void 0) {
276
- localVarQueryParameter["application_id"] = applicationId;
277
- }
278
- if (applicationVersion !== void 0) {
279
- localVarQueryParameter["application_version"] = applicationVersion;
280
- }
281
- if (include) {
282
- localVarQueryParameter["include"] = include;
283
- }
284
- if (page !== void 0) {
285
- localVarQueryParameter["page"] = page;
286
- }
287
- if (pageSize !== void 0) {
288
- localVarQueryParameter["page_size"] = pageSize;
289
- }
290
- if (sort) {
291
- localVarQueryParameter["sort"] = sort;
292
- }
293
331
  setSearchParams(localVarUrlObj, localVarQueryParameter);
294
332
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
295
333
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -299,11 +337,11 @@ var PublicApiAxiosParamCreator = function(configuration) {
299
337
  };
300
338
  },
301
339
  /**
302
- * Returns the list of the applications, available to the caller. The application is available if any of the version of the application is assigned to the user organization. To switch between organizations, the user should re-login and choose the needed organization.
303
- * @summary List Applications
340
+ * 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.
341
+ * @summary List available applications
304
342
  * @param {number} [page]
305
343
  * @param {number} [pageSize]
306
- * @param {Array<string> | null} [sort]
344
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;application_id&#x60; - &#x60;name&#x60; - &#x60;description&#x60; - &#x60;regulatory_classes&#x60; **Examples:** - &#x60;?sort&#x3D;application_id&#x60; - Sort by application_id ascending - &#x60;?sort&#x3D;-name&#x60; - Sort by name descending - &#x60;?sort&#x3D;+description&amp;sort&#x3D;name&#x60; - Sort by description ascending, then name descending
307
345
  * @param {*} [options] Override http request option.
308
346
  * @throws {RequiredError}
309
347
  */
@@ -322,7 +360,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
322
360
  localVarQueryParameter["page"] = page;
323
361
  }
324
362
  if (pageSize !== void 0) {
325
- localVarQueryParameter["page_size"] = pageSize;
363
+ localVarQueryParameter["page-size"] = pageSize;
326
364
  }
327
365
  if (sort) {
328
366
  localVarQueryParameter["sort"] = sort;
@@ -336,21 +374,23 @@ var PublicApiAxiosParamCreator = function(configuration) {
336
374
  };
337
375
  },
338
376
  /**
339
- * Get the list of the results for the run items
340
- * @summary List Run Results
341
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
342
- * @param {Array<string> | null} [itemIdIn] Filter for items ids
343
- * @param {Array<string> | null} [referenceIn] Filter for items by their reference from the input payload
344
- * @param {Array<ItemStatus> | null} [statusIn] Filter for items in certain statuses
377
+ * 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
378
+ * @summary List Run Items
379
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
380
+ * @param {Array<string> | null} [itemIdIn] Filter for item ids
381
+ * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
382
+ * @param {ItemState | null} [state] Filter items by their state
383
+ * @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
384
+ * @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
345
385
  * @param {number} [page]
346
386
  * @param {number} [pageSize]
347
- * @param {Array<string> | null} [sort]
387
+ * @param {Array<string> | null} [sort] Sort the items by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;item_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;item_id&#x60; - Sort by id of the item (ascending) - &#x60;?sort&#x3D;-external_id&#x60; - Sort by external ID (descending) - &#x60;?sort&#x3D;custom_metadata&amp;sort&#x3D;-external_id&#x60; - Sort by metadata, then by external ID (descending)
348
388
  * @param {*} [options] Override http request option.
349
389
  * @throws {RequiredError}
350
390
  */
351
- listRunResultsV1RunsApplicationRunIdResultsGet: async (applicationRunId, itemIdIn, referenceIn, statusIn, page, pageSize, sort, options = {}) => {
352
- assertParamExists("listRunResultsV1RunsApplicationRunIdResultsGet", "applicationRunId", applicationRunId);
353
- const localVarPath = `/v1/runs/{application_run_id}/results`.replace(`{${"application_run_id"}}`, encodeURIComponent(String(applicationRunId)));
391
+ listRunItemsV1RunsRunIdItemsGet: async (runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options = {}) => {
392
+ assertParamExists("listRunItemsV1RunsRunIdItemsGet", "runId", runId);
393
+ const localVarPath = `/v1/runs/{run_id}/items`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
354
394
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
355
395
  let baseOptions;
356
396
  if (configuration) {
@@ -363,11 +403,17 @@ var PublicApiAxiosParamCreator = function(configuration) {
363
403
  if (itemIdIn) {
364
404
  localVarQueryParameter["item_id__in"] = itemIdIn;
365
405
  }
366
- if (referenceIn) {
367
- localVarQueryParameter["reference__in"] = referenceIn;
406
+ if (externalIdIn) {
407
+ localVarQueryParameter["external_id__in"] = externalIdIn;
408
+ }
409
+ if (state !== void 0) {
410
+ localVarQueryParameter["state"] = state;
411
+ }
412
+ if (terminationReason !== void 0) {
413
+ localVarQueryParameter["termination_reason"] = terminationReason;
368
414
  }
369
- if (statusIn) {
370
- localVarQueryParameter["status__in"] = statusIn;
415
+ if (customMetadata !== void 0) {
416
+ localVarQueryParameter["custom_metadata"] = customMetadata;
371
417
  }
372
418
  if (page !== void 0) {
373
419
  localVarQueryParameter["page"] = page;
@@ -387,20 +433,20 @@ var PublicApiAxiosParamCreator = function(configuration) {
387
433
  };
388
434
  },
389
435
  /**
390
- * Returns the list of the application versions for this application, available to the caller. The application version is available if it is assigned to the user\'s organization. The application versions are assigned to the organization by the Aignostics admin. To assign or unassign a version from your organization, please contact Aignostics support team.
391
- * @summary List Versions By Application Id
392
- * @param {string} applicationId
436
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
437
+ * @summary List Runs
438
+ * @param {string | null} [applicationId] Optional application ID filter
439
+ * @param {string | null} [applicationVersion] Optional Version Name
440
+ * @param {string | null} [externalId] Optionally filter runs by items with this external ID
441
+ * @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: &#x60;$.study&#x60; - Runs that have a study field defined - **Exact value match**: &#x60;$.study ? (@ &#x3D;&#x3D; \&quot;high\&quot;)&#x60; - Runs with specific study value - **Numeric comparison**: &#x60;$.confidence_score ? (@ &gt; 0.75)&#x60; - Runs with confidence score greater than 0.75 - **Array operations**: &#x60;$.tags[*] ? (@ &#x3D;&#x3D; \&quot;draft\&quot;)&#x60; - Runs with tags array containing \&quot;draft\&quot; - **Complex conditions**: &#x60;$.resources ? (@.gpu_count &gt; 2 &amp;&amp; @.memory_gb &gt;&#x3D; 16)&#x60; - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: &#x60;%24.study&#x60; - **Exact value match**: &#x60;%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)&#x60; - **Numeric comparison**: &#x60;%24.confidence_score%20%3F%20(%40%20%3E%200.75)&#x60; - **Array operations**: &#x60;%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)&#x60; - **Complex conditions**: &#x60;%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)&#x60; #### Notes - JSONPath expressions are evaluated using PostgreSQL\&#39;s &#x60;@?&#x60; operator - The &#x60;$.&#x60; prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use &#x60;&amp;&amp;&#x60; for AND operations and &#x60;||&#x60; for OR operations - Regular expressions use &#x60;like_regex&#x60; with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
393
442
  * @param {number} [page]
394
443
  * @param {number} [pageSize]
395
- * @param {string | null} [version]
396
- * @param {Array<any> | null} [include]
397
- * @param {Array<string> | null} [sort]
444
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;run_id&#x60; - &#x60;application_id&#x60; - &#x60;version_number&#x60; - &#x60;custom_metadata&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;submitted_at&#x60; - Sort by creation time (ascending) - &#x60;?sort&#x3D;-submitted_at&#x60; - Sort by creation time (descending) - &#x60;?sort&#x3D;state&amp;sort&#x3D;-submitted_at&#x60; - Sort by state, then by time (descending)
398
445
  * @param {*} [options] Override http request option.
399
446
  * @throws {RequiredError}
400
447
  */
401
- listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet: async (applicationId, page, pageSize, version, include, sort, options = {}) => {
402
- assertParamExists("listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet", "applicationId", applicationId);
403
- const localVarPath = `/v1/applications/{application_id}/versions`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId)));
448
+ listRunsV1RunsGet: async (applicationId, applicationVersion, externalId, customMetadata, page, pageSize, sort, options = {}) => {
449
+ const localVarPath = `/v1/runs`;
404
450
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
405
451
  let baseOptions;
406
452
  if (configuration) {
@@ -410,18 +456,24 @@ var PublicApiAxiosParamCreator = function(configuration) {
410
456
  const localVarHeaderParameter = {};
411
457
  const localVarQueryParameter = {};
412
458
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
459
+ if (applicationId !== void 0) {
460
+ localVarQueryParameter["application_id"] = applicationId;
461
+ }
462
+ if (applicationVersion !== void 0) {
463
+ localVarQueryParameter["application_version"] = applicationVersion;
464
+ }
465
+ if (externalId !== void 0) {
466
+ localVarQueryParameter["external_id"] = externalId;
467
+ }
468
+ if (customMetadata !== void 0) {
469
+ localVarQueryParameter["custom_metadata"] = customMetadata;
470
+ }
413
471
  if (page !== void 0) {
414
472
  localVarQueryParameter["page"] = page;
415
473
  }
416
474
  if (pageSize !== void 0) {
417
475
  localVarQueryParameter["page_size"] = pageSize;
418
476
  }
419
- if (version !== void 0) {
420
- localVarQueryParameter["version"] = version;
421
- }
422
- if (include) {
423
- localVarQueryParameter["include"] = include;
424
- }
425
477
  if (sort) {
426
478
  localVarQueryParameter["sort"] = sort;
427
479
  }
@@ -432,6 +484,97 @@ var PublicApiAxiosParamCreator = function(configuration) {
432
484
  url: toPathString(localVarUrlObj),
433
485
  options: localVarRequestOptions
434
486
  };
487
+ },
488
+ /**
489
+ * 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`.
490
+ * @summary Put Item Custom Metadata By Run
491
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
492
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
493
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
494
+ * @param {*} [options] Override http request option.
495
+ * @throws {RequiredError}
496
+ */
497
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut: async (runId, externalId, customMetadataUpdateRequest, options = {}) => {
498
+ assertParamExists("putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut", "runId", runId);
499
+ assertParamExists("putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut", "externalId", externalId);
500
+ assertParamExists("putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut", "customMetadataUpdateRequest", customMetadataUpdateRequest);
501
+ const localVarPath = `/v1/runs/{run_id}/items/{external_id}/custom-metadata`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"external_id"}}`, encodeURIComponent(String(externalId)));
502
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
503
+ let baseOptions;
504
+ if (configuration) {
505
+ baseOptions = configuration.baseOptions;
506
+ }
507
+ const localVarRequestOptions = { method: "PUT", ...baseOptions, ...options };
508
+ const localVarHeaderParameter = {};
509
+ const localVarQueryParameter = {};
510
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
511
+ localVarHeaderParameter["Content-Type"] = "application/json";
512
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
513
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
514
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
515
+ localVarRequestOptions.data = serializeDataIfNeeded(customMetadataUpdateRequest, localVarRequestOptions, configuration);
516
+ return {
517
+ url: toPathString(localVarUrlObj),
518
+ options: localVarRequestOptions
519
+ };
520
+ },
521
+ /**
522
+ * 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.
523
+ * @summary Put Run Custom Metadata
524
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
525
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
526
+ * @param {*} [options] Override http request option.
527
+ * @throws {RequiredError}
528
+ */
529
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut: async (runId, customMetadataUpdateRequest, options = {}) => {
530
+ assertParamExists("putRunCustomMetadataV1RunsRunIdCustomMetadataPut", "runId", runId);
531
+ assertParamExists("putRunCustomMetadataV1RunsRunIdCustomMetadataPut", "customMetadataUpdateRequest", customMetadataUpdateRequest);
532
+ const localVarPath = `/v1/runs/{run_id}/custom-metadata`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
533
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
534
+ let baseOptions;
535
+ if (configuration) {
536
+ baseOptions = configuration.baseOptions;
537
+ }
538
+ const localVarRequestOptions = { method: "PUT", ...baseOptions, ...options };
539
+ const localVarHeaderParameter = {};
540
+ const localVarQueryParameter = {};
541
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
542
+ localVarHeaderParameter["Content-Type"] = "application/json";
543
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
544
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
545
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
546
+ localVarRequestOptions.data = serializeDataIfNeeded(customMetadataUpdateRequest, localVarRequestOptions, configuration);
547
+ return {
548
+ url: toPathString(localVarUrlObj),
549
+ options: localVarRequestOptions
550
+ };
551
+ },
552
+ /**
553
+ * Retrieve details of a specific application by its ID.
554
+ * @summary Read Application By Id
555
+ * @param {string} applicationId
556
+ * @param {*} [options] Override http request option.
557
+ * @throws {RequiredError}
558
+ */
559
+ readApplicationByIdV1ApplicationsApplicationIdGet: async (applicationId, options = {}) => {
560
+ assertParamExists("readApplicationByIdV1ApplicationsApplicationIdGet", "applicationId", applicationId);
561
+ const localVarPath = `/v1/applications/{application_id}`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId)));
562
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
563
+ let baseOptions;
564
+ if (configuration) {
565
+ baseOptions = configuration.baseOptions;
566
+ }
567
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
568
+ const localVarHeaderParameter = {};
569
+ const localVarQueryParameter = {};
570
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
571
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
572
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
573
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
574
+ return {
575
+ url: toPathString(localVarUrlObj),
576
+ options: localVarRequestOptions
577
+ };
435
578
  }
436
579
  };
437
580
  };
@@ -439,47 +582,75 @@ var PublicApiFp = function(configuration) {
439
582
  const localVarAxiosParamCreator = PublicApiAxiosParamCreator(configuration);
440
583
  return {
441
584
  /**
442
- * The application run can be canceled by the user who created the application run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
443
- * @summary Cancel Application Run
444
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
585
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
586
+ * @summary Application Version Details
587
+ * @param {string} applicationId
588
+ * @param {string} version
589
+ * @param {*} [options] Override http request option.
590
+ * @throws {RequiredError}
591
+ */
592
+ async applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(applicationId, version, options) {
593
+ const localVarAxiosArgs = await localVarAxiosParamCreator.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(applicationId, version, options);
594
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
595
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet"]?.[localVarOperationServerIndex]?.url;
596
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
597
+ },
598
+ /**
599
+ * 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.
600
+ * @summary Cancel Run
601
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
445
602
  * @param {*} [options] Override http request option.
446
603
  * @throws {RequiredError}
447
604
  */
448
- async cancelApplicationRunV1RunsApplicationRunIdCancelPost(applicationRunId, options) {
449
- const localVarAxiosArgs = await localVarAxiosParamCreator.cancelApplicationRunV1RunsApplicationRunIdCancelPost(applicationRunId, options);
605
+ async cancelRunV1RunsRunIdCancelPost(runId, options) {
606
+ const localVarAxiosArgs = await localVarAxiosParamCreator.cancelRunV1RunsRunIdCancelPost(runId, options);
450
607
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
451
- const localVarOperationServerBasePath = operationServerMap["PublicApi.cancelApplicationRunV1RunsApplicationRunIdCancelPost"]?.[localVarOperationServerIndex]?.url;
608
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.cancelRunV1RunsRunIdCancelPost"]?.[localVarOperationServerIndex]?.url;
452
609
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
453
610
  },
454
611
  /**
455
- * The endpoint is used to process the input items by the chosen application version. The endpoint returns the `application_run_id`. The processing fo the items is done asynchronously. To check the status or cancel the execution, use the /v1/runs/{application_run_id} endpoint. ### Payload The payload includes `application_version_id` and `items` base fields. `application_version_id` is the id used for `/v1/versions/{application_id}` endpoint. `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 metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_version_id: \"test-app:v0.0.2\", items: [{ \"reference\": \"slide_1\", <-- Input ID to connect the input and the output artifact \"input_artifacts\": [{ \"name\": \"input_slide\", <-- Name of the artifact defined by the application (For HETA it is\"input_slide\") \"download_url\": \"https://...\", <-- signed URL to the input file in the S3 or GCS. Should be valid for more than 6 days \"metadata\": { <-- The metadata fields defined by the application. (The example fields set for a slide files are provided) \"checksum_base64_crc32c\": \"abc12==\", \"mime_type\": \"image/tiff\", \"height\": 100, \"weight\": 500, \"mpp\": 0.543 } }] }] } ``` ### Response The endpoint returns the application run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{application_run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
456
- * @summary Create Application Run
612
+ * 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
613
+ * @summary Initiate Run
457
614
  * @param {RunCreationRequest} runCreationRequest
458
615
  * @param {*} [options] Override http request option.
459
616
  * @throws {RequiredError}
460
617
  */
461
- async createApplicationRunV1RunsPost(runCreationRequest, options) {
462
- const localVarAxiosArgs = await localVarAxiosParamCreator.createApplicationRunV1RunsPost(runCreationRequest, options);
618
+ async createRunV1RunsPost(runCreationRequest, options) {
619
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createRunV1RunsPost(runCreationRequest, options);
620
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
621
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.createRunV1RunsPost"]?.[localVarOperationServerIndex]?.url;
622
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
623
+ },
624
+ /**
625
+ * 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.
626
+ * @summary Delete Run Items
627
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
628
+ * @param {*} [options] Override http request option.
629
+ * @throws {RequiredError}
630
+ */
631
+ async deleteRunItemsV1RunsRunIdArtifactsDelete(runId, options) {
632
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRunItemsV1RunsRunIdArtifactsDelete(runId, options);
463
633
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
464
- const localVarOperationServerBasePath = operationServerMap["PublicApi.createApplicationRunV1RunsPost"]?.[localVarOperationServerIndex]?.url;
634
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.deleteRunItemsV1RunsRunIdArtifactsDelete"]?.[localVarOperationServerIndex]?.url;
465
635
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
466
636
  },
467
637
  /**
468
- * Delete the application run results. It can only be called when the application is in a final state (meaning it\'s not in `received` or `pending` states). To delete the results of the running artifacts, first call `POST /v1/runs/{application_run_id}/cancel` to cancel the application run. The output results are deleted automatically 30 days after the application run is finished.
469
- * @summary Delete Application Run Results
470
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
638
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
639
+ * @summary Get Item By Run
640
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
641
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
471
642
  * @param {*} [options] Override http request option.
472
643
  * @throws {RequiredError}
473
644
  */
474
- async deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(applicationRunId, options) {
475
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(applicationRunId, options);
645
+ async getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options) {
646
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options);
476
647
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
477
- const localVarOperationServerBasePath = operationServerMap["PublicApi.deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete"]?.[localVarOperationServerIndex]?.url;
648
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.getItemByRunV1RunsRunIdItemsExternalIdGet"]?.[localVarOperationServerIndex]?.url;
478
649
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
479
650
  },
480
651
  /**
481
- *
482
- * @summary Get Me
652
+ * 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)
653
+ * @summary Get current user
483
654
  * @param {*} [options] Override http request option.
484
655
  * @throws {RequiredError}
485
656
  */
@@ -490,87 +661,113 @@ var PublicApiFp = function(configuration) {
490
661
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
491
662
  },
492
663
  /**
493
- * Returns the details of the application run. The application run is available as soon as it is created via `POST /runs/` endpoint. To download the items results, call `/runs/{application_run_id}/results`. The application is only available to the user who triggered it, regardless of the role.
494
- * @summary Get Run
495
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
496
- * @param {Array<any> | null} [include]
664
+ * 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.
665
+ * @summary Get run details
666
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
497
667
  * @param {*} [options] Override http request option.
498
668
  * @throws {RequiredError}
499
669
  */
500
- async getRunV1RunsApplicationRunIdGet(applicationRunId, include, options) {
501
- const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsApplicationRunIdGet(applicationRunId, include, options);
670
+ async getRunV1RunsRunIdGet(runId, options) {
671
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsRunIdGet(runId, options);
502
672
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
503
- const localVarOperationServerBasePath = operationServerMap["PublicApi.getRunV1RunsApplicationRunIdGet"]?.[localVarOperationServerIndex]?.url;
673
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.getRunV1RunsRunIdGet"]?.[localVarOperationServerIndex]?.url;
504
674
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
505
675
  },
506
676
  /**
507
- * The endpoint returns the application runs triggered by the caller. After the application run is created by POST /v1/runs, it becomes available for the current endpoint
508
- * @summary List Application Runs
509
- * @param {string | null} [applicationId] Optional application ID filter
510
- * @param {string | null} [applicationVersion] Optional application version filter
511
- * @param {Array<any> | null} [include] Request optional output values. Used internally by the platform
677
+ * 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.
678
+ * @summary List available applications
512
679
  * @param {number} [page]
513
680
  * @param {number} [pageSize]
514
- * @param {Array<string> | null} [sort]
681
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;application_id&#x60; - &#x60;name&#x60; - &#x60;description&#x60; - &#x60;regulatory_classes&#x60; **Examples:** - &#x60;?sort&#x3D;application_id&#x60; - Sort by application_id ascending - &#x60;?sort&#x3D;-name&#x60; - Sort by name descending - &#x60;?sort&#x3D;+description&amp;sort&#x3D;name&#x60; - Sort by description ascending, then name descending
515
682
  * @param {*} [options] Override http request option.
516
683
  * @throws {RequiredError}
517
684
  */
518
- async listApplicationRunsV1RunsGet(applicationId, applicationVersion, include, page, pageSize, sort, options) {
519
- const localVarAxiosArgs = await localVarAxiosParamCreator.listApplicationRunsV1RunsGet(applicationId, applicationVersion, include, page, pageSize, sort, options);
685
+ async listApplicationsV1ApplicationsGet(page, pageSize, sort, options) {
686
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listApplicationsV1ApplicationsGet(page, pageSize, sort, options);
520
687
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
521
- const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationRunsV1RunsGet"]?.[localVarOperationServerIndex]?.url;
688
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationsV1ApplicationsGet"]?.[localVarOperationServerIndex]?.url;
522
689
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
523
690
  },
524
691
  /**
525
- * Returns the list of the applications, available to the caller. The application is available if any of the version of the application is assigned to the user organization. To switch between organizations, the user should re-login and choose the needed organization.
526
- * @summary List Applications
692
+ * 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
693
+ * @summary List Run Items
694
+ * @param {string} runId Run id, returned by &#x60;POST /v1/runs/&#x60; endpoint
695
+ * @param {Array<string> | null} [itemIdIn] Filter for item ids
696
+ * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
697
+ * @param {ItemState | null} [state] Filter items by their state
698
+ * @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
699
+ * @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
527
700
  * @param {number} [page]
528
701
  * @param {number} [pageSize]
529
- * @param {Array<string> | null} [sort]
702
+ * @param {Array<string> | null} [sort] Sort the items by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;item_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;item_id&#x60; - Sort by id of the item (ascending) - &#x60;?sort&#x3D;-external_id&#x60; - Sort by external ID (descending) - &#x60;?sort&#x3D;custom_metadata&amp;sort&#x3D;-external_id&#x60; - Sort by metadata, then by external ID (descending)
530
703
  * @param {*} [options] Override http request option.
531
704
  * @throws {RequiredError}
532
705
  */
533
- async listApplicationsV1ApplicationsGet(page, pageSize, sort, options) {
534
- const localVarAxiosArgs = await localVarAxiosParamCreator.listApplicationsV1ApplicationsGet(page, pageSize, sort, options);
706
+ async listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options) {
707
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options);
535
708
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
536
- const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationsV1ApplicationsGet"]?.[localVarOperationServerIndex]?.url;
709
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunItemsV1RunsRunIdItemsGet"]?.[localVarOperationServerIndex]?.url;
537
710
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
538
711
  },
539
712
  /**
540
- * Get the list of the results for the run items
541
- * @summary List Run Results
542
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
543
- * @param {Array<string> | null} [itemIdIn] Filter for items ids
544
- * @param {Array<string> | null} [referenceIn] Filter for items by their reference from the input payload
545
- * @param {Array<ItemStatus> | null} [statusIn] Filter for items in certain statuses
713
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
714
+ * @summary List Runs
715
+ * @param {string | null} [applicationId] Optional application ID filter
716
+ * @param {string | null} [applicationVersion] Optional Version Name
717
+ * @param {string | null} [externalId] Optionally filter runs by items with this external ID
718
+ * @param {string | null} [customMetadata] Use PostgreSQL JSONPath expressions to filter runs by their custom_metadata. #### URL Encoding Required **Important**: JSONPath expressions contain special characters that must be URL-encoded when used in query parameters. Most HTTP clients handle this automatically, but when constructing URLs manually, please ensure proper encoding. #### Examples (Clear Format): - **Field existence**: &#x60;$.study&#x60; - Runs that have a study field defined - **Exact value match**: &#x60;$.study ? (@ &#x3D;&#x3D; \&quot;high\&quot;)&#x60; - Runs with specific study value - **Numeric comparison**: &#x60;$.confidence_score ? (@ &gt; 0.75)&#x60; - Runs with confidence score greater than 0.75 - **Array operations**: &#x60;$.tags[*] ? (@ &#x3D;&#x3D; \&quot;draft\&quot;)&#x60; - Runs with tags array containing \&quot;draft\&quot; - **Complex conditions**: &#x60;$.resources ? (@.gpu_count &gt; 2 &amp;&amp; @.memory_gb &gt;&#x3D; 16)&#x60; - Runs with high resource requirements #### Examples (URL-Encoded Format): - **Field existence**: &#x60;%24.study&#x60; - **Exact value match**: &#x60;%24.study%20%3F%20(%40%20%3D%3D%20%22high%22)&#x60; - **Numeric comparison**: &#x60;%24.confidence_score%20%3F%20(%40%20%3E%200.75)&#x60; - **Array operations**: &#x60;%24.tags%5B*%5D%20%3F%20(%40%20%3D%3D%20%22draft%22)&#x60; - **Complex conditions**: &#x60;%24.resources%20%3F%20(%40.gpu_count%20%3E%202%20%26%26%20%40.memory_gb%20%3E%3D%2016)&#x60; #### Notes - JSONPath expressions are evaluated using PostgreSQL\&#39;s &#x60;@?&#x60; operator - The &#x60;$.&#x60; prefix is automatically added to root-level field references if missing - String values in conditions must be enclosed in double quotes - Use &#x60;&amp;&amp;&#x60; for AND operations and &#x60;||&#x60; for OR operations - Regular expressions use &#x60;like_regex&#x60; with standard regex syntax - **Please remember to URL-encode the entire JSONPath expression when making HTTP requests**
546
719
  * @param {number} [page]
547
720
  * @param {number} [pageSize]
548
- * @param {Array<string> | null} [sort]
721
+ * @param {Array<string> | null} [sort] Sort the results by one or more fields. Use &#x60;+&#x60; for ascending and &#x60;-&#x60; for descending order. **Available fields:** - &#x60;run_id&#x60; - &#x60;application_id&#x60; - &#x60;version_number&#x60; - &#x60;custom_metadata&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#x60; - &#x60;terminated_at&#x60; - &#x60;termination_reason&#x60; **Examples:** - &#x60;?sort&#x3D;submitted_at&#x60; - Sort by creation time (ascending) - &#x60;?sort&#x3D;-submitted_at&#x60; - Sort by creation time (descending) - &#x60;?sort&#x3D;state&amp;sort&#x3D;-submitted_at&#x60; - Sort by state, then by time (descending)
722
+ * @param {*} [options] Override http request option.
723
+ * @throws {RequiredError}
724
+ */
725
+ async listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, sort, options) {
726
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, sort, options);
727
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
728
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunsV1RunsGet"]?.[localVarOperationServerIndex]?.url;
729
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
730
+ },
731
+ /**
732
+ * 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`.
733
+ * @summary Put Item Custom Metadata By Run
734
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
735
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
736
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
737
+ * @param {*} [options] Override http request option.
738
+ * @throws {RequiredError}
739
+ */
740
+ async putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(runId, externalId, customMetadataUpdateRequest, options) {
741
+ const localVarAxiosArgs = await localVarAxiosParamCreator.putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(runId, externalId, customMetadataUpdateRequest, options);
742
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
743
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut"]?.[localVarOperationServerIndex]?.url;
744
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
745
+ },
746
+ /**
747
+ * 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.
748
+ * @summary Put Run Custom Metadata
749
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
750
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
549
751
  * @param {*} [options] Override http request option.
550
752
  * @throws {RequiredError}
551
753
  */
552
- async listRunResultsV1RunsApplicationRunIdResultsGet(applicationRunId, itemIdIn, referenceIn, statusIn, page, pageSize, sort, options) {
553
- const localVarAxiosArgs = await localVarAxiosParamCreator.listRunResultsV1RunsApplicationRunIdResultsGet(applicationRunId, itemIdIn, referenceIn, statusIn, page, pageSize, sort, options);
754
+ async putRunCustomMetadataV1RunsRunIdCustomMetadataPut(runId, customMetadataUpdateRequest, options) {
755
+ const localVarAxiosArgs = await localVarAxiosParamCreator.putRunCustomMetadataV1RunsRunIdCustomMetadataPut(runId, customMetadataUpdateRequest, options);
554
756
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
555
- const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunResultsV1RunsApplicationRunIdResultsGet"]?.[localVarOperationServerIndex]?.url;
757
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.putRunCustomMetadataV1RunsRunIdCustomMetadataPut"]?.[localVarOperationServerIndex]?.url;
556
758
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
557
759
  },
558
760
  /**
559
- * Returns the list of the application versions for this application, available to the caller. The application version is available if it is assigned to the user\'s organization. The application versions are assigned to the organization by the Aignostics admin. To assign or unassign a version from your organization, please contact Aignostics support team.
560
- * @summary List Versions By Application Id
761
+ * Retrieve details of a specific application by its ID.
762
+ * @summary Read Application By Id
561
763
  * @param {string} applicationId
562
- * @param {number} [page]
563
- * @param {number} [pageSize]
564
- * @param {string | null} [version]
565
- * @param {Array<any> | null} [include]
566
- * @param {Array<string> | null} [sort]
567
764
  * @param {*} [options] Override http request option.
568
765
  * @throws {RequiredError}
569
766
  */
570
- async listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(applicationId, page, pageSize, version, include, sort, options) {
571
- const localVarAxiosArgs = await localVarAxiosParamCreator.listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(applicationId, page, pageSize, version, include, sort, options);
767
+ async readApplicationByIdV1ApplicationsApplicationIdGet(applicationId, options) {
768
+ const localVarAxiosArgs = await localVarAxiosParamCreator.readApplicationByIdV1ApplicationsApplicationIdGet(applicationId, options);
572
769
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
573
- const localVarOperationServerBasePath = operationServerMap["PublicApi.listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet"]?.[localVarOperationServerIndex]?.url;
770
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.readApplicationByIdV1ApplicationsApplicationIdGet"]?.[localVarOperationServerIndex]?.url;
574
771
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2__default.default, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
575
772
  }
576
773
  };
@@ -579,67 +776,77 @@ var PublicApiFactory = function(configuration, basePath, axios) {
579
776
  const localVarFp = PublicApiFp(configuration);
580
777
  return {
581
778
  /**
582
- * The application run can be canceled by the user who created the application run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
583
- * @summary Cancel Application Run
584
- * @param {PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest} requestParameters Request parameters.
779
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
780
+ * @summary Application Version Details
781
+ * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
585
782
  * @param {*} [options] Override http request option.
586
783
  * @throws {RequiredError}
587
784
  */
588
- cancelApplicationRunV1RunsApplicationRunIdCancelPost(requestParameters, options) {
589
- return localVarFp.cancelApplicationRunV1RunsApplicationRunIdCancelPost(requestParameters.applicationRunId, options).then((request) => request(axios, basePath));
785
+ applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters, options) {
786
+ return localVarFp.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters.applicationId, requestParameters.version, options).then((request) => request(axios, basePath));
590
787
  },
591
788
  /**
592
- * The endpoint is used to process the input items by the chosen application version. The endpoint returns the `application_run_id`. The processing fo the items is done asynchronously. To check the status or cancel the execution, use the /v1/runs/{application_run_id} endpoint. ### Payload The payload includes `application_version_id` and `items` base fields. `application_version_id` is the id used for `/v1/versions/{application_id}` endpoint. `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 metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_version_id: \"test-app:v0.0.2\", items: [{ \"reference\": \"slide_1\", <-- Input ID to connect the input and the output artifact \"input_artifacts\": [{ \"name\": \"input_slide\", <-- Name of the artifact defined by the application (For HETA it is\"input_slide\") \"download_url\": \"https://...\", <-- signed URL to the input file in the S3 or GCS. Should be valid for more than 6 days \"metadata\": { <-- The metadata fields defined by the application. (The example fields set for a slide files are provided) \"checksum_base64_crc32c\": \"abc12==\", \"mime_type\": \"image/tiff\", \"height\": 100, \"weight\": 500, \"mpp\": 0.543 } }] }] } ``` ### Response The endpoint returns the application run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{application_run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
593
- * @summary Create Application Run
594
- * @param {PublicApiCreateApplicationRunV1RunsPostRequest} requestParameters Request parameters.
789
+ * 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.
790
+ * @summary Cancel Run
791
+ * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
595
792
  * @param {*} [options] Override http request option.
596
793
  * @throws {RequiredError}
597
794
  */
598
- createApplicationRunV1RunsPost(requestParameters, options) {
599
- return localVarFp.createApplicationRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(axios, basePath));
795
+ cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
796
+ return localVarFp.cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(axios, basePath));
600
797
  },
601
798
  /**
602
- * Delete the application run results. It can only be called when the application is in a final state (meaning it\'s not in `received` or `pending` states). To delete the results of the running artifacts, first call `POST /v1/runs/{application_run_id}/cancel` to cancel the application run. The output results are deleted automatically 30 days after the application run is finished.
603
- * @summary Delete Application Run Results
604
- * @param {PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest} requestParameters Request parameters.
799
+ * 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
800
+ * @summary Initiate Run
801
+ * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
605
802
  * @param {*} [options] Override http request option.
606
803
  * @throws {RequiredError}
607
804
  */
608
- deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(requestParameters, options) {
609
- return localVarFp.deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(requestParameters.applicationRunId, options).then((request) => request(axios, basePath));
805
+ createRunV1RunsPost(requestParameters, options) {
806
+ return localVarFp.createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(axios, basePath));
610
807
  },
611
808
  /**
612
- *
613
- * @summary Get Me
809
+ * 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.
810
+ * @summary Delete Run Items
811
+ * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
614
812
  * @param {*} [options] Override http request option.
615
813
  * @throws {RequiredError}
616
814
  */
617
- getMeV1MeGet(options) {
618
- return localVarFp.getMeV1MeGet(options).then((request) => request(axios, basePath));
815
+ deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters, options) {
816
+ return localVarFp.deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters.runId, options).then((request) => request(axios, basePath));
619
817
  },
620
818
  /**
621
- * Returns the details of the application run. The application run is available as soon as it is created via `POST /runs/` endpoint. To download the items results, call `/runs/{application_run_id}/results`. The application is only available to the user who triggered it, regardless of the role.
622
- * @summary Get Run
623
- * @param {PublicApiGetRunV1RunsApplicationRunIdGetRequest} requestParameters Request parameters.
819
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
820
+ * @summary Get Item By Run
821
+ * @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
624
822
  * @param {*} [options] Override http request option.
625
823
  * @throws {RequiredError}
626
824
  */
627
- getRunV1RunsApplicationRunIdGet(requestParameters, options) {
628
- return localVarFp.getRunV1RunsApplicationRunIdGet(requestParameters.applicationRunId, requestParameters.include, options).then((request) => request(axios, basePath));
825
+ getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
826
+ return localVarFp.getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(axios, basePath));
629
827
  },
630
828
  /**
631
- * The endpoint returns the application runs triggered by the caller. After the application run is created by POST /v1/runs, it becomes available for the current endpoint
632
- * @summary List Application Runs
633
- * @param {PublicApiListApplicationRunsV1RunsGetRequest} requestParameters Request parameters.
829
+ * 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)
830
+ * @summary Get current user
634
831
  * @param {*} [options] Override http request option.
635
832
  * @throws {RequiredError}
636
833
  */
637
- listApplicationRunsV1RunsGet(requestParameters = {}, options) {
638
- return localVarFp.listApplicationRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.include, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
834
+ getMeV1MeGet(options) {
835
+ return localVarFp.getMeV1MeGet(options).then((request) => request(axios, basePath));
639
836
  },
640
837
  /**
641
- * Returns the list of the applications, available to the caller. The application is available if any of the version of the application is assigned to the user organization. To switch between organizations, the user should re-login and choose the needed organization.
642
- * @summary List Applications
838
+ * 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.
839
+ * @summary Get run details
840
+ * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
841
+ * @param {*} [options] Override http request option.
842
+ * @throws {RequiredError}
843
+ */
844
+ getRunV1RunsRunIdGet(requestParameters, options) {
845
+ return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(axios, basePath));
846
+ },
847
+ /**
848
+ * 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.
849
+ * @summary List available applications
643
850
  * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
644
851
  * @param {*} [options] Override http request option.
645
852
  * @throws {RequiredError}
@@ -648,96 +855,137 @@ var PublicApiFactory = function(configuration, basePath, axios) {
648
855
  return localVarFp.listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
649
856
  },
650
857
  /**
651
- * Get the list of the results for the run items
652
- * @summary List Run Results
653
- * @param {PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest} requestParameters Request parameters.
858
+ * 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
859
+ * @summary List Run Items
860
+ * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
654
861
  * @param {*} [options] Override http request option.
655
862
  * @throws {RequiredError}
656
863
  */
657
- listRunResultsV1RunsApplicationRunIdResultsGet(requestParameters, options) {
658
- return localVarFp.listRunResultsV1RunsApplicationRunIdResultsGet(requestParameters.applicationRunId, requestParameters.itemIdIn, requestParameters.referenceIn, requestParameters.statusIn, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
864
+ listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
865
+ return localVarFp.listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
659
866
  },
660
867
  /**
661
- * Returns the list of the application versions for this application, available to the caller. The application version is available if it is assigned to the user\'s organization. The application versions are assigned to the organization by the Aignostics admin. To assign or unassign a version from your organization, please contact Aignostics support team.
662
- * @summary List Versions By Application Id
663
- * @param {PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest} requestParameters Request parameters.
868
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
869
+ * @summary List Runs
870
+ * @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
664
871
  * @param {*} [options] Override http request option.
665
872
  * @throws {RequiredError}
666
873
  */
667
- listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(requestParameters, options) {
668
- return localVarFp.listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(requestParameters.applicationId, requestParameters.page, requestParameters.pageSize, requestParameters.version, requestParameters.include, requestParameters.sort, options).then((request) => request(axios, basePath));
874
+ listRunsV1RunsGet(requestParameters = {}, options) {
875
+ return localVarFp.listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
876
+ },
877
+ /**
878
+ * 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`.
879
+ * @summary Put Item Custom Metadata By Run
880
+ * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
881
+ * @param {*} [options] Override http request option.
882
+ * @throws {RequiredError}
883
+ */
884
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters, options) {
885
+ return localVarFp.putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters.runId, requestParameters.externalId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(axios, basePath));
886
+ },
887
+ /**
888
+ * 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.
889
+ * @summary Put Run Custom Metadata
890
+ * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
891
+ * @param {*} [options] Override http request option.
892
+ * @throws {RequiredError}
893
+ */
894
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters, options) {
895
+ return localVarFp.putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters.runId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(axios, basePath));
896
+ },
897
+ /**
898
+ * Retrieve details of a specific application by its ID.
899
+ * @summary Read Application By Id
900
+ * @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
901
+ * @param {*} [options] Override http request option.
902
+ * @throws {RequiredError}
903
+ */
904
+ readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
905
+ return localVarFp.readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(axios, basePath));
669
906
  }
670
907
  };
671
908
  };
672
909
  var PublicApi = class extends BaseAPI {
673
910
  /**
674
- * The application run can be canceled by the user who created the application run. The execution can be canceled any time while the application is not in a final state. The pending items will not be processed and will not add to the cost. When the application is canceled, the already completed items stay available for download.
675
- * @summary Cancel Application Run
676
- * @param {PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest} requestParameters Request parameters.
911
+ * Get the application version details. Allows caller to retrieve information about application version based on provided application version ID.
912
+ * @summary Application Version Details
913
+ * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
677
914
  * @param {*} [options] Override http request option.
678
915
  * @throws {RequiredError}
679
916
  * @memberof PublicApi
680
917
  */
681
- cancelApplicationRunV1RunsApplicationRunIdCancelPost(requestParameters, options) {
682
- return PublicApiFp(this.configuration).cancelApplicationRunV1RunsApplicationRunIdCancelPost(requestParameters.applicationRunId, options).then((request) => request(this.axios, this.basePath));
918
+ applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters, options) {
919
+ return PublicApiFp(this.configuration).applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters.applicationId, requestParameters.version, options).then((request) => request(this.axios, this.basePath));
683
920
  }
684
921
  /**
685
- * The endpoint is used to process the input items by the chosen application version. The endpoint returns the `application_run_id`. The processing fo the items is done asynchronously. To check the status or cancel the execution, use the /v1/runs/{application_run_id} endpoint. ### Payload The payload includes `application_version_id` and `items` base fields. `application_version_id` is the id used for `/v1/versions/{application_id}` endpoint. `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 metadata, specific to the chosen application. Example payload structure with the comments: ``` { application_version_id: \"test-app:v0.0.2\", items: [{ \"reference\": \"slide_1\", <-- Input ID to connect the input and the output artifact \"input_artifacts\": [{ \"name\": \"input_slide\", <-- Name of the artifact defined by the application (For HETA it is\"input_slide\") \"download_url\": \"https://...\", <-- signed URL to the input file in the S3 or GCS. Should be valid for more than 6 days \"metadata\": { <-- The metadata fields defined by the application. (The example fields set for a slide files are provided) \"checksum_base64_crc32c\": \"abc12==\", \"mime_type\": \"image/tiff\", \"height\": 100, \"weight\": 500, \"mpp\": 0.543 } }] }] } ``` ### Response The endpoint returns the application run UUID. After that the job is scheduled for the execution in the background. To check the status of the run call `v1/runs/{application_run_id}`. ### Rejection Apart from the authentication, authorization and malformed input error, the request can be rejected when the quota limit is exceeded. More details on quotas is described in the documentation
686
- * @summary Create Application Run
687
- * @param {PublicApiCreateApplicationRunV1RunsPostRequest} requestParameters Request parameters.
922
+ * 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.
923
+ * @summary Cancel Run
924
+ * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
688
925
  * @param {*} [options] Override http request option.
689
926
  * @throws {RequiredError}
690
927
  * @memberof PublicApi
691
928
  */
692
- createApplicationRunV1RunsPost(requestParameters, options) {
693
- return PublicApiFp(this.configuration).createApplicationRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(this.axios, this.basePath));
929
+ cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
930
+ return PublicApiFp(this.configuration).cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
694
931
  }
695
932
  /**
696
- * Delete the application run results. It can only be called when the application is in a final state (meaning it\'s not in `received` or `pending` states). To delete the results of the running artifacts, first call `POST /v1/runs/{application_run_id}/cancel` to cancel the application run. The output results are deleted automatically 30 days after the application run is finished.
697
- * @summary Delete Application Run Results
698
- * @param {PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest} requestParameters Request parameters.
933
+ * 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
934
+ * @summary Initiate Run
935
+ * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
699
936
  * @param {*} [options] Override http request option.
700
937
  * @throws {RequiredError}
701
938
  * @memberof PublicApi
702
939
  */
703
- deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(requestParameters, options) {
704
- return PublicApiFp(this.configuration).deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(requestParameters.applicationRunId, options).then((request) => request(this.axios, this.basePath));
940
+ createRunV1RunsPost(requestParameters, options) {
941
+ return PublicApiFp(this.configuration).createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(this.axios, this.basePath));
705
942
  }
706
943
  /**
707
- *
708
- * @summary Get Me
944
+ * 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.
945
+ * @summary Delete Run Items
946
+ * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
709
947
  * @param {*} [options] Override http request option.
710
948
  * @throws {RequiredError}
711
949
  * @memberof PublicApi
712
950
  */
713
- getMeV1MeGet(options) {
714
- return PublicApiFp(this.configuration).getMeV1MeGet(options).then((request) => request(this.axios, this.basePath));
951
+ deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters, options) {
952
+ return PublicApiFp(this.configuration).deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
715
953
  }
716
954
  /**
717
- * Returns the details of the application run. The application run is available as soon as it is created via `POST /runs/` endpoint. To download the items results, call `/runs/{application_run_id}/results`. The application is only available to the user who triggered it, regardless of the role.
718
- * @summary Get Run
719
- * @param {PublicApiGetRunV1RunsApplicationRunIdGetRequest} requestParameters Request parameters.
955
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
956
+ * @summary Get Item By Run
957
+ * @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
720
958
  * @param {*} [options] Override http request option.
721
959
  * @throws {RequiredError}
722
960
  * @memberof PublicApi
723
961
  */
724
- getRunV1RunsApplicationRunIdGet(requestParameters, options) {
725
- return PublicApiFp(this.configuration).getRunV1RunsApplicationRunIdGet(requestParameters.applicationRunId, requestParameters.include, options).then((request) => request(this.axios, this.basePath));
962
+ getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
963
+ return PublicApiFp(this.configuration).getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(this.axios, this.basePath));
726
964
  }
727
965
  /**
728
- * The endpoint returns the application runs triggered by the caller. After the application run is created by POST /v1/runs, it becomes available for the current endpoint
729
- * @summary List Application Runs
730
- * @param {PublicApiListApplicationRunsV1RunsGetRequest} requestParameters Request parameters.
966
+ * 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)
967
+ * @summary Get current user
731
968
  * @param {*} [options] Override http request option.
732
969
  * @throws {RequiredError}
733
970
  * @memberof PublicApi
734
971
  */
735
- listApplicationRunsV1RunsGet(requestParameters = {}, options) {
736
- return PublicApiFp(this.configuration).listApplicationRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.include, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
972
+ getMeV1MeGet(options) {
973
+ return PublicApiFp(this.configuration).getMeV1MeGet(options).then((request) => request(this.axios, this.basePath));
737
974
  }
738
975
  /**
739
- * Returns the list of the applications, available to the caller. The application is available if any of the version of the application is assigned to the user organization. To switch between organizations, the user should re-login and choose the needed organization.
740
- * @summary List Applications
976
+ * 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.
977
+ * @summary Get run details
978
+ * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
979
+ * @param {*} [options] Override http request option.
980
+ * @throws {RequiredError}
981
+ * @memberof PublicApi
982
+ */
983
+ getRunV1RunsRunIdGet(requestParameters, options) {
984
+ return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
985
+ }
986
+ /**
987
+ * 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.
988
+ * @summary List available applications
741
989
  * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
742
990
  * @param {*} [options] Override http request option.
743
991
  * @throws {RequiredError}
@@ -747,26 +995,59 @@ var PublicApi = class extends BaseAPI {
747
995
  return PublicApiFp(this.configuration).listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
748
996
  }
749
997
  /**
750
- * Get the list of the results for the run items
751
- * @summary List Run Results
752
- * @param {PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest} requestParameters Request parameters.
998
+ * 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
999
+ * @summary List Run Items
1000
+ * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
1001
+ * @param {*} [options] Override http request option.
1002
+ * @throws {RequiredError}
1003
+ * @memberof PublicApi
1004
+ */
1005
+ listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
1006
+ return PublicApiFp(this.configuration).listRunItemsV1RunsRunIdItemsGet(requestParameters.runId, requestParameters.itemIdIn, requestParameters.externalIdIn, requestParameters.state, requestParameters.terminationReason, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
1007
+ }
1008
+ /**
1009
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
1010
+ * @summary List Runs
1011
+ * @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
1012
+ * @param {*} [options] Override http request option.
1013
+ * @throws {RequiredError}
1014
+ * @memberof PublicApi
1015
+ */
1016
+ listRunsV1RunsGet(requestParameters = {}, options) {
1017
+ return PublicApiFp(this.configuration).listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
1018
+ }
1019
+ /**
1020
+ * 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`.
1021
+ * @summary Put Item Custom Metadata By Run
1022
+ * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
1023
+ * @param {*} [options] Override http request option.
1024
+ * @throws {RequiredError}
1025
+ * @memberof PublicApi
1026
+ */
1027
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters, options) {
1028
+ return PublicApiFp(this.configuration).putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters.runId, requestParameters.externalId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(this.axios, this.basePath));
1029
+ }
1030
+ /**
1031
+ * 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.
1032
+ * @summary Put Run Custom Metadata
1033
+ * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
753
1034
  * @param {*} [options] Override http request option.
754
1035
  * @throws {RequiredError}
755
1036
  * @memberof PublicApi
756
1037
  */
757
- listRunResultsV1RunsApplicationRunIdResultsGet(requestParameters, options) {
758
- return PublicApiFp(this.configuration).listRunResultsV1RunsApplicationRunIdResultsGet(requestParameters.applicationRunId, requestParameters.itemIdIn, requestParameters.referenceIn, requestParameters.statusIn, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
1038
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters, options) {
1039
+ return PublicApiFp(this.configuration).putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters.runId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(this.axios, this.basePath));
759
1040
  }
760
1041
  /**
761
- * Returns the list of the application versions for this application, available to the caller. The application version is available if it is assigned to the user\'s organization. The application versions are assigned to the organization by the Aignostics admin. To assign or unassign a version from your organization, please contact Aignostics support team.
762
- * @summary List Versions By Application Id
763
- * @param {PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest} requestParameters Request parameters.
1042
+ * Retrieve details of a specific application by its ID.
1043
+ * @summary Read Application By Id
1044
+ * @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
764
1045
  * @param {*} [options] Override http request option.
765
1046
  * @throws {RequiredError}
766
1047
  * @memberof PublicApi
767
1048
  */
768
- listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(requestParameters, options) {
769
- return PublicApiFp(this.configuration).listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(requestParameters.applicationId, requestParameters.page, requestParameters.pageSize, requestParameters.version, requestParameters.include, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
1049
+ readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
1050
+ return PublicApiFp(this.configuration).readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(this.axios, this.basePath));
770
1051
  }
771
1052
  };
772
1053
 
@@ -1082,36 +1363,77 @@ var PlatformSDKHttp = class {
1082
1363
  }
1083
1364
  }
1084
1365
  /**
1085
- * Retrieve all versions of a specific application
1366
+ * Retrieve detailed information about a specific application version
1086
1367
  *
1087
- * This method fetches all available versions for a given application ID.
1088
- * Application versions represent different iterations or configurations of
1089
- * an AI model, allowing you to choose specific versions for processing.
1368
+ * This method fetches comprehensive details about a specific version of an
1369
+ * application, including its changelog, release date, and any version-specific
1370
+ * configurations or features.
1090
1371
  *
1091
1372
  * @param applicationId - The unique identifier of the application
1092
- * @returns A promise that resolves to an array of application version objects
1093
- * @throws {AuthenticationError} If no valid authentication token is available
1094
- * @throws {Error} If the request fails due to network issues, invalid application ID, or API errors
1373
+ * @param version - The version string of the application to retrieve
1374
+ * @returns A promise that resolves to the application version details
1375
+ * @throws {Error} If the request fails due to network issues, authentication problems, invalid application ID or version, or API errors
1095
1376
  *
1096
1377
  * @example
1097
1378
  * ```typescript
1098
1379
  * const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
1099
1380
  *
1100
1381
  * try {
1101
- * const versions = await sdk.listApplicationVersions('app-123');
1102
- * console.log(`Found ${versions.length} versions for application`);
1103
- * versions.forEach(version => {
1104
- * console.log(`- Version ${version.version} (ID: ${version.id})`);
1382
+ * const appVersion = await sdk.getApplicationVersionDetails('app-123', 'v1.2.0');
1383
+ * console.log(`Application Version: ${appVersion.version}`);
1384
+ * console.log(`Release Date: ${appVersion.release_date}`);
1385
+ * console.log(`Changelog: ${appVersion.changelog}`);
1386
+ * } catch (error) {
1387
+ * console.error('Failed to get application version details:', error.message);
1388
+ * }
1389
+ * ```
1390
+ */
1391
+ async getApplicationVersionDetails(applicationId, version) {
1392
+ const client = await this.#getClient();
1393
+ try {
1394
+ const response = await client.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet({
1395
+ applicationId,
1396
+ version
1397
+ });
1398
+ return response.data;
1399
+ } catch (error) {
1400
+ handleRequestError(error);
1401
+ }
1402
+ }
1403
+ /**
1404
+ * Retrieve detailed information about a specific application
1405
+ *
1406
+ * This method fetches comprehensive details about an application, including
1407
+ * its name, description, regulatory classes, and all available versions.
1408
+ * This provides more detailed information compared to the summary returned
1409
+ * by `listApplications()`.
1410
+ *
1411
+ * @param applicationId - The unique identifier of the application to retrieve
1412
+ * @returns A promise that resolves to the complete application details
1413
+ * @throws {Error} If the request fails due to network issues, authentication problems, invalid application ID, or API errors
1414
+ *
1415
+ * @example
1416
+ * ```typescript
1417
+ * const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
1418
+ *
1419
+ * try {
1420
+ * const application = await sdk.getApplication('app-123');
1421
+ * console.log(`Application: ${application.name}`);
1422
+ * console.log(`Description: ${application.description}`);
1423
+ * console.log(`Available versions: ${application.versions.length}`);
1424
+ *
1425
+ * application.versions.forEach(version => {
1426
+ * console.log(`- ${version.version} (ID: ${version.application_version_id})`);
1105
1427
  * });
1106
1428
  * } catch (error) {
1107
- * console.error('Failed to list application versions:', error.message);
1429
+ * console.error('Failed to get application details:', error.message);
1108
1430
  * }
1109
1431
  * ```
1110
1432
  */
1111
- async listApplicationVersions(applicationId) {
1433
+ async getApplication(applicationId) {
1112
1434
  const client = await this.#getClient();
1113
1435
  try {
1114
- const response = await client.listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet({
1436
+ const response = await client.readApplicationByIdV1ApplicationsApplicationIdGet({
1115
1437
  applicationId
1116
1438
  });
1117
1439
  return response.data;
@@ -1160,9 +1482,11 @@ var PlatformSDKHttp = class {
1160
1482
  async listApplicationRuns(options) {
1161
1483
  const client = await this.#getClient();
1162
1484
  try {
1163
- const response = await client.listApplicationRunsV1RunsGet({
1485
+ const response = await client.listRunsV1RunsGet({
1164
1486
  applicationId: options?.applicationId,
1165
- applicationVersion: options?.applicationVersion
1487
+ applicationVersion: options?.applicationVersion,
1488
+ customMetadata: options?.customMetadata,
1489
+ sort: options?.sort
1166
1490
  });
1167
1491
  return response.data;
1168
1492
  } catch (error) {
@@ -1210,7 +1534,7 @@ var PlatformSDKHttp = class {
1210
1534
  async createApplicationRun(request) {
1211
1535
  const client = await this.#getClient();
1212
1536
  try {
1213
- const response = await client.createApplicationRunV1RunsPost({
1537
+ const response = await client.createRunV1RunsPost({
1214
1538
  runCreationRequest: request
1215
1539
  });
1216
1540
  return response.data;
@@ -1246,8 +1570,8 @@ var PlatformSDKHttp = class {
1246
1570
  async getRun(applicationRunId) {
1247
1571
  const client = await this.#getClient();
1248
1572
  try {
1249
- const response = await client.getRunV1RunsApplicationRunIdGet({
1250
- applicationRunId
1573
+ const response = await client.getRunV1RunsRunIdGet({
1574
+ runId: applicationRunId
1251
1575
  });
1252
1576
  return response.data;
1253
1577
  } catch (error) {
@@ -1284,8 +1608,8 @@ var PlatformSDKHttp = class {
1284
1608
  async cancelApplicationRun(applicationRunId) {
1285
1609
  const client = await this.#getClient();
1286
1610
  try {
1287
- await client.cancelApplicationRunV1RunsApplicationRunIdCancelPost({
1288
- applicationRunId
1611
+ await client.cancelRunV1RunsRunIdCancelPost({
1612
+ runId: applicationRunId
1289
1613
  });
1290
1614
  } catch (error) {
1291
1615
  handleRequestError(error);
@@ -1324,8 +1648,8 @@ var PlatformSDKHttp = class {
1324
1648
  async listRunResults(applicationRunId) {
1325
1649
  const client = await this.#getClient();
1326
1650
  try {
1327
- const response = await client.listRunResultsV1RunsApplicationRunIdResultsGet({
1328
- applicationRunId
1651
+ const response = await client.listRunItemsV1RunsRunIdItemsGet({
1652
+ runId: applicationRunId
1329
1653
  });
1330
1654
  return response.data;
1331
1655
  } catch (error) {
@@ -1380,18 +1704,26 @@ var PlatformSDKHttp = class {
1380
1704
  var index_default = PlatformSDKHttp;
1381
1705
 
1382
1706
  exports.APIError = APIError;
1383
- exports.ApplicationRunStatus = ApplicationRunStatus;
1707
+ exports.ArtifactOutput = ArtifactOutput;
1708
+ exports.ArtifactState = ArtifactState;
1709
+ exports.ArtifactTerminationReason = ArtifactTerminationReason;
1384
1710
  exports.AuthenticationError = AuthenticationError;
1385
1711
  exports.BaseError = BaseError;
1386
1712
  exports.Configuration = Configuration;
1387
1713
  exports.ConfigurationError = ConfigurationError;
1388
- exports.ItemStatus = ItemStatus;
1714
+ exports.ItemOutput = ItemOutput;
1715
+ exports.ItemState = ItemState;
1716
+ exports.ItemTerminationReason = ItemTerminationReason;
1389
1717
  exports.OutputArtifactScope = OutputArtifactScope;
1718
+ exports.OutputArtifactVisibility = OutputArtifactVisibility;
1390
1719
  exports.PlatformSDKHttp = PlatformSDKHttp;
1391
1720
  exports.PublicApi = PublicApi;
1392
1721
  exports.PublicApiAxiosParamCreator = PublicApiAxiosParamCreator;
1393
1722
  exports.PublicApiFactory = PublicApiFactory;
1394
1723
  exports.PublicApiFp = PublicApiFp;
1724
+ exports.RunOutput = RunOutput;
1725
+ exports.RunState = RunState;
1726
+ exports.RunTerminationReason = RunTerminationReason;
1395
1727
  exports.default = index_default;
1396
1728
  //# sourceMappingURL=index.cjs.map
1397
1729
  //# sourceMappingURL=index.cjs.map