@aignostics/sdk 2.3.1 → 3.0.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.js CHANGED
@@ -4,7 +4,7 @@ import z from 'zod';
4
4
  // package.json
5
5
  var package_default = {
6
6
  version: "0.0.0-development"};
7
- var BASE_PATH = "https://raw.githubusercontent.com/api".replace(/\/+$/, "");
7
+ var BASE_PATH = "https://platform-staging.aignostics.com/api".replace(/\/+$/, "");
8
8
  var BaseAPI = class {
9
9
  constructor(configuration, basePath = BASE_PATH, axios = globalAxios2) {
10
10
  this.basePath = basePath;
@@ -77,40 +77,102 @@ var createRequestFunction = function(axiosArgs, globalAxios3, BASE_PATH2, config
77
77
  };
78
78
 
79
79
  // src/generated/api.ts
80
- var ApplicationRunStatus = {
81
- CanceledSystem: "CANCELED_SYSTEM",
82
- CanceledUser: "CANCELED_USER",
83
- Completed: "COMPLETED",
84
- CompletedWithError: "COMPLETED_WITH_ERROR",
85
- Received: "RECEIVED",
86
- Rejected: "REJECTED",
87
- Running: "RUNNING",
88
- Scheduled: "SCHEDULED"
80
+ var ArtifactOutput = {
81
+ None: "NONE",
82
+ Available: "AVAILABLE",
83
+ DeletedByUser: "DELETED_BY_USER",
84
+ DeletedBySystem: "DELETED_BY_SYSTEM"
89
85
  };
90
- var ItemStatus = {
86
+ var ArtifactState = {
91
87
  Pending: "PENDING",
92
- CanceledUser: "CANCELED_USER",
93
- CanceledSystem: "CANCELED_SYSTEM",
94
- ErrorUser: "ERROR_USER",
95
- ErrorSystem: "ERROR_SYSTEM",
96
- Succeeded: "SUCCEEDED"
88
+ Processing: "PROCESSING",
89
+ Terminated: "TERMINATED"
90
+ };
91
+ var ArtifactTerminationReason = {
92
+ Succeeded: "SUCCEEDED",
93
+ UserError: "USER_ERROR",
94
+ SystemError: "SYSTEM_ERROR",
95
+ Skipped: "SKIPPED"
96
+ };
97
+ var ItemOutput = {
98
+ None: "NONE",
99
+ Full: "FULL"
100
+ };
101
+ var ItemState = {
102
+ Pending: "PENDING",
103
+ Processing: "PROCESSING",
104
+ Terminated: "TERMINATED"
105
+ };
106
+ var ItemTerminationReason = {
107
+ Succeeded: "SUCCEEDED",
108
+ UserError: "USER_ERROR",
109
+ SystemError: "SYSTEM_ERROR",
110
+ Skipped: "SKIPPED"
97
111
  };
98
112
  var OutputArtifactScope = {
99
113
  Item: "ITEM",
100
114
  Global: "GLOBAL"
101
115
  };
116
+ var OutputArtifactVisibility = {
117
+ Internal: "INTERNAL",
118
+ External: "EXTERNAL"
119
+ };
120
+ var RunOutput = {
121
+ None: "NONE",
122
+ Partial: "PARTIAL",
123
+ Full: "FULL"
124
+ };
125
+ var RunState = {
126
+ Pending: "PENDING",
127
+ Processing: "PROCESSING",
128
+ Terminated: "TERMINATED"
129
+ };
130
+ var RunTerminationReason = {
131
+ AllItemsProcessed: "ALL_ITEMS_PROCESSED",
132
+ CanceledBySystem: "CANCELED_BY_SYSTEM",
133
+ CanceledByUser: "CANCELED_BY_USER"
134
+ };
102
135
  var PublicApiAxiosParamCreator = function(configuration) {
103
136
  return {
104
137
  /**
105
- * 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.
106
- * @summary Cancel Application Run
107
- * @param {string} applicationRunId Application run id, returned by `POST /runs/` endpoint
138
+ * Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
139
+ * @summary Application Version Details
140
+ * @param {string} applicationId
141
+ * @param {string} version
108
142
  * @param {*} [options] Override http request option.
109
143
  * @throws {RequiredError}
110
144
  */
111
- cancelApplicationRunV1RunsApplicationRunIdCancelPost: async (applicationRunId, options = {}) => {
112
- assertParamExists("cancelApplicationRunV1RunsApplicationRunIdCancelPost", "applicationRunId", applicationRunId);
113
- const localVarPath = `/v1/runs/{application_run_id}/cancel`.replace(`{${"application_run_id"}}`, encodeURIComponent(String(applicationRunId)));
145
+ applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet: async (applicationId, version, options = {}) => {
146
+ assertParamExists("applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet", "applicationId", applicationId);
147
+ assertParamExists("applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet", "version", version);
148
+ const localVarPath = `/v1/applications/{application_id}/versions/{version}`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId))).replace(`{${"version"}}`, encodeURIComponent(String(version)));
149
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
150
+ let baseOptions;
151
+ if (configuration) {
152
+ baseOptions = configuration.baseOptions;
153
+ }
154
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
155
+ const localVarHeaderParameter = {};
156
+ const localVarQueryParameter = {};
157
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
158
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
159
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
160
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
161
+ return {
162
+ url: toPathString(localVarUrlObj),
163
+ options: localVarRequestOptions
164
+ };
165
+ },
166
+ /**
167
+ * The run can be canceled by the user who created the 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.
168
+ * @summary Cancel Run
169
+ * @param {string} runId Run id, returned by `POST /runs/` endpoint
170
+ * @param {*} [options] Override http request option.
171
+ * @throws {RequiredError}
172
+ */
173
+ cancelRunV1RunsRunIdCancelPost: async (runId, options = {}) => {
174
+ assertParamExists("cancelRunV1RunsRunIdCancelPost", "runId", runId);
175
+ const localVarPath = `/v1/runs/{run_id}/cancel`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
114
176
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
115
177
  let baseOptions;
116
178
  if (configuration) {
@@ -129,14 +191,14 @@ var PublicApiAxiosParamCreator = function(configuration) {
129
191
  };
130
192
  },
131
193
  /**
132
- * 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
133
- * @summary Create Application Run
194
+ * 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 of four, though this number may be reduced during periods of high demand. 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\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_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 (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 an 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) 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 `v1/runs/{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
195
+ * @summary Initiate Run
134
196
  * @param {RunCreationRequest} runCreationRequest
135
197
  * @param {*} [options] Override http request option.
136
198
  * @throws {RequiredError}
137
199
  */
138
- createApplicationRunV1RunsPost: async (runCreationRequest, options = {}) => {
139
- assertParamExists("createApplicationRunV1RunsPost", "runCreationRequest", runCreationRequest);
200
+ createRunV1RunsPost: async (runCreationRequest, options = {}) => {
201
+ assertParamExists("createRunV1RunsPost", "runCreationRequest", runCreationRequest);
140
202
  const localVarPath = `/v1/runs`;
141
203
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
142
204
  let baseOptions;
@@ -158,15 +220,15 @@ var PublicApiAxiosParamCreator = function(configuration) {
158
220
  };
159
221
  },
160
222
  /**
161
- * 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.
162
- * @summary Delete Application Run Results
163
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
223
+ * 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 (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
224
+ * @summary Delete Run Items
225
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
164
226
  * @param {*} [options] Override http request option.
165
227
  * @throws {RequiredError}
166
228
  */
167
- deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete: async (applicationRunId, options = {}) => {
168
- assertParamExists("deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete", "applicationRunId", applicationRunId);
169
- const localVarPath = `/v1/runs/{application_run_id}/results`.replace(`{${"application_run_id"}}`, encodeURIComponent(String(applicationRunId)));
229
+ deleteRunItemsV1RunsRunIdArtifactsDelete: async (runId, options = {}) => {
230
+ assertParamExists("deleteRunItemsV1RunsRunIdArtifactsDelete", "runId", runId);
231
+ const localVarPath = `/v1/runs/{run_id}/artifacts`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
170
232
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
171
233
  let baseOptions;
172
234
  if (configuration) {
@@ -185,13 +247,17 @@ var PublicApiAxiosParamCreator = function(configuration) {
185
247
  };
186
248
  },
187
249
  /**
188
- *
189
- * @summary Get Me
250
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
251
+ * @summary Get Item By Run
252
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
253
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
190
254
  * @param {*} [options] Override http request option.
191
255
  * @throws {RequiredError}
192
256
  */
193
- getMeV1MeGet: async (options = {}) => {
194
- const localVarPath = `/v1/me`;
257
+ getItemByRunV1RunsRunIdItemsExternalIdGet: async (runId, externalId, options = {}) => {
258
+ assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "runId", runId);
259
+ assertParamExists("getItemByRunV1RunsRunIdItemsExternalIdGet", "externalId", externalId);
260
+ const localVarPath = `/v1/runs/{run_id}/items/{external_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"external_id"}}`, encodeURIComponent(String(externalId)));
195
261
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
196
262
  let baseOptions;
197
263
  if (configuration) {
@@ -210,16 +276,13 @@ var PublicApiAxiosParamCreator = function(configuration) {
210
276
  };
211
277
  },
212
278
  /**
213
- * 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.
214
- * @summary Get Run
215
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
216
- * @param {Array<any> | null} [include]
279
+ * 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)
280
+ * @summary Get current user
217
281
  * @param {*} [options] Override http request option.
218
282
  * @throws {RequiredError}
219
283
  */
220
- getRunV1RunsApplicationRunIdGet: async (applicationRunId, include, options = {}) => {
221
- assertParamExists("getRunV1RunsApplicationRunIdGet", "applicationRunId", applicationRunId);
222
- const localVarPath = `/v1/runs/{application_run_id}`.replace(`{${"application_run_id"}}`, encodeURIComponent(String(applicationRunId)));
284
+ getMeV1MeGet: async (options = {}) => {
285
+ const localVarPath = `/v1/me`;
223
286
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
224
287
  let baseOptions;
225
288
  if (configuration) {
@@ -229,9 +292,6 @@ var PublicApiAxiosParamCreator = function(configuration) {
229
292
  const localVarHeaderParameter = {};
230
293
  const localVarQueryParameter = {};
231
294
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
232
- if (include) {
233
- localVarQueryParameter["include"] = include;
234
- }
235
295
  setSearchParams(localVarUrlObj, localVarQueryParameter);
236
296
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
237
297
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -241,19 +301,15 @@ var PublicApiAxiosParamCreator = function(configuration) {
241
301
  };
242
302
  },
243
303
  /**
244
- * 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
245
- * @summary List Application Runs
246
- * @param {string | null} [applicationId] Optional application ID filter
247
- * @param {string | null} [applicationVersion] Optional application version filter
248
- * @param {Array<any> | null} [include] Request optional output values. Used internally by the platform
249
- * @param {number} [page]
250
- * @param {number} [pageSize]
251
- * @param {Array<string> | null} [sort]
304
+ * 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 `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
305
+ * @summary Get run details
306
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
252
307
  * @param {*} [options] Override http request option.
253
308
  * @throws {RequiredError}
254
309
  */
255
- listApplicationRunsV1RunsGet: async (applicationId, applicationVersion, include, page, pageSize, sort, options = {}) => {
256
- const localVarPath = `/v1/runs`;
310
+ getRunV1RunsRunIdGet: async (runId, options = {}) => {
311
+ assertParamExists("getRunV1RunsRunIdGet", "runId", runId);
312
+ const localVarPath = `/v1/runs/{run_id}`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
257
313
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
258
314
  let baseOptions;
259
315
  if (configuration) {
@@ -263,24 +319,6 @@ var PublicApiAxiosParamCreator = function(configuration) {
263
319
  const localVarHeaderParameter = {};
264
320
  const localVarQueryParameter = {};
265
321
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
266
- if (applicationId !== void 0) {
267
- localVarQueryParameter["application_id"] = applicationId;
268
- }
269
- if (applicationVersion !== void 0) {
270
- localVarQueryParameter["application_version"] = applicationVersion;
271
- }
272
- if (include) {
273
- localVarQueryParameter["include"] = include;
274
- }
275
- if (page !== void 0) {
276
- localVarQueryParameter["page"] = page;
277
- }
278
- if (pageSize !== void 0) {
279
- localVarQueryParameter["page_size"] = pageSize;
280
- }
281
- if (sort) {
282
- localVarQueryParameter["sort"] = sort;
283
- }
284
322
  setSearchParams(localVarUrlObj, localVarQueryParameter);
285
323
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
286
324
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -290,11 +328,11 @@ var PublicApiAxiosParamCreator = function(configuration) {
290
328
  };
291
329
  },
292
330
  /**
293
- * 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.
294
- * @summary List Applications
331
+ * 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.
332
+ * @summary List available applications
295
333
  * @param {number} [page]
296
334
  * @param {number} [pageSize]
297
- * @param {Array<string> | null} [sort]
335
+ * @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
298
336
  * @param {*} [options] Override http request option.
299
337
  * @throws {RequiredError}
300
338
  */
@@ -313,7 +351,7 @@ var PublicApiAxiosParamCreator = function(configuration) {
313
351
  localVarQueryParameter["page"] = page;
314
352
  }
315
353
  if (pageSize !== void 0) {
316
- localVarQueryParameter["page_size"] = pageSize;
354
+ localVarQueryParameter["page-size"] = pageSize;
317
355
  }
318
356
  if (sort) {
319
357
  localVarQueryParameter["sort"] = sort;
@@ -327,21 +365,23 @@ var PublicApiAxiosParamCreator = function(configuration) {
327
365
  };
328
366
  },
329
367
  /**
330
- * Get the list of the results for the run items
331
- * @summary List Run Results
332
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
333
- * @param {Array<string> | null} [itemIdIn] Filter for items ids
334
- * @param {Array<string> | null} [referenceIn] Filter for items by their reference from the input payload
335
- * @param {Array<ItemStatus> | null} [statusIn] Filter for items in certain statuses
368
+ * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata 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
369
+ * @summary List Run Items
370
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
371
+ * @param {Array<string> | null} [itemIdIn] Filter for item ids
372
+ * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
373
+ * @param {ItemState | null} [state] Filter items by their state
374
+ * @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
375
+ * @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
336
376
  * @param {number} [page]
337
377
  * @param {number} [pageSize]
338
- * @param {Array<string> | null} [sort]
378
+ * @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;run_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#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)
339
379
  * @param {*} [options] Override http request option.
340
380
  * @throws {RequiredError}
341
381
  */
342
- listRunResultsV1RunsApplicationRunIdResultsGet: async (applicationRunId, itemIdIn, referenceIn, statusIn, page, pageSize, sort, options = {}) => {
343
- assertParamExists("listRunResultsV1RunsApplicationRunIdResultsGet", "applicationRunId", applicationRunId);
344
- const localVarPath = `/v1/runs/{application_run_id}/results`.replace(`{${"application_run_id"}}`, encodeURIComponent(String(applicationRunId)));
382
+ listRunItemsV1RunsRunIdItemsGet: async (runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options = {}) => {
383
+ assertParamExists("listRunItemsV1RunsRunIdItemsGet", "runId", runId);
384
+ const localVarPath = `/v1/runs/{run_id}/items`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
345
385
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
346
386
  let baseOptions;
347
387
  if (configuration) {
@@ -354,11 +394,17 @@ var PublicApiAxiosParamCreator = function(configuration) {
354
394
  if (itemIdIn) {
355
395
  localVarQueryParameter["item_id__in"] = itemIdIn;
356
396
  }
357
- if (referenceIn) {
358
- localVarQueryParameter["reference__in"] = referenceIn;
397
+ if (externalIdIn) {
398
+ localVarQueryParameter["external_id__in"] = externalIdIn;
399
+ }
400
+ if (state !== void 0) {
401
+ localVarQueryParameter["state"] = state;
402
+ }
403
+ if (terminationReason !== void 0) {
404
+ localVarQueryParameter["termination_reason"] = terminationReason;
359
405
  }
360
- if (statusIn) {
361
- localVarQueryParameter["status__in"] = statusIn;
406
+ if (customMetadata !== void 0) {
407
+ localVarQueryParameter["custom_metadata"] = customMetadata;
362
408
  }
363
409
  if (page !== void 0) {
364
410
  localVarQueryParameter["page"] = page;
@@ -378,20 +424,20 @@ var PublicApiAxiosParamCreator = function(configuration) {
378
424
  };
379
425
  },
380
426
  /**
381
- * 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.
382
- * @summary List Versions By Application Id
383
- * @param {string} applicationId
427
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
428
+ * @summary List Runs
429
+ * @param {string | null} [applicationId] Optional application ID filter
430
+ * @param {string | null} [applicationVersion] Optional Version Name
431
+ * @param {string | null} [externalId] Optionally filter runs by items with this external ID
432
+ * @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, 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 - **Remember to URL-encode the entire JSONPath expression when making HTTP requests**
384
433
  * @param {number} [page]
385
434
  * @param {number} [pageSize]
386
- * @param {string | null} [version]
387
- * @param {Array<any> | null} [include]
388
- * @param {Array<string> | null} [sort]
435
+ * @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_version_id&#x60; - &#x60;organization_id&#x60; - &#x60;status&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#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;status&amp;sort&#x3D;-submitted_at&#x60; - Sort by status, then by time (descending)
389
436
  * @param {*} [options] Override http request option.
390
437
  * @throws {RequiredError}
391
438
  */
392
- listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet: async (applicationId, page, pageSize, version, include, sort, options = {}) => {
393
- assertParamExists("listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet", "applicationId", applicationId);
394
- const localVarPath = `/v1/applications/{application_id}/versions`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId)));
439
+ listRunsV1RunsGet: async (applicationId, applicationVersion, externalId, customMetadata, page, pageSize, sort, options = {}) => {
440
+ const localVarPath = `/v1/runs`;
395
441
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
396
442
  let baseOptions;
397
443
  if (configuration) {
@@ -401,18 +447,24 @@ var PublicApiAxiosParamCreator = function(configuration) {
401
447
  const localVarHeaderParameter = {};
402
448
  const localVarQueryParameter = {};
403
449
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
450
+ if (applicationId !== void 0) {
451
+ localVarQueryParameter["application_id"] = applicationId;
452
+ }
453
+ if (applicationVersion !== void 0) {
454
+ localVarQueryParameter["application_version"] = applicationVersion;
455
+ }
456
+ if (externalId !== void 0) {
457
+ localVarQueryParameter["external_id"] = externalId;
458
+ }
459
+ if (customMetadata !== void 0) {
460
+ localVarQueryParameter["custom_metadata"] = customMetadata;
461
+ }
404
462
  if (page !== void 0) {
405
463
  localVarQueryParameter["page"] = page;
406
464
  }
407
465
  if (pageSize !== void 0) {
408
466
  localVarQueryParameter["page_size"] = pageSize;
409
467
  }
410
- if (version !== void 0) {
411
- localVarQueryParameter["version"] = version;
412
- }
413
- if (include) {
414
- localVarQueryParameter["include"] = include;
415
- }
416
468
  if (sort) {
417
469
  localVarQueryParameter["sort"] = sort;
418
470
  }
@@ -423,6 +475,97 @@ var PublicApiAxiosParamCreator = function(configuration) {
423
475
  url: toPathString(localVarUrlObj),
424
476
  options: localVarRequestOptions
425
477
  };
478
+ },
479
+ /**
480
+ *
481
+ * @summary Put Item Custom Metadata By Run
482
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
483
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
484
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
485
+ * @param {*} [options] Override http request option.
486
+ * @throws {RequiredError}
487
+ */
488
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut: async (runId, externalId, customMetadataUpdateRequest, options = {}) => {
489
+ assertParamExists("putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut", "runId", runId);
490
+ assertParamExists("putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut", "externalId", externalId);
491
+ assertParamExists("putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut", "customMetadataUpdateRequest", customMetadataUpdateRequest);
492
+ const localVarPath = `/v1/runs/{run_id}/items/{external_id}/custom-metadata`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId))).replace(`{${"external_id"}}`, encodeURIComponent(String(externalId)));
493
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
494
+ let baseOptions;
495
+ if (configuration) {
496
+ baseOptions = configuration.baseOptions;
497
+ }
498
+ const localVarRequestOptions = { method: "PUT", ...baseOptions, ...options };
499
+ const localVarHeaderParameter = {};
500
+ const localVarQueryParameter = {};
501
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
502
+ localVarHeaderParameter["Content-Type"] = "application/json";
503
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
504
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
505
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
506
+ localVarRequestOptions.data = serializeDataIfNeeded(customMetadataUpdateRequest, localVarRequestOptions, configuration);
507
+ return {
508
+ url: toPathString(localVarUrlObj),
509
+ options: localVarRequestOptions
510
+ };
511
+ },
512
+ /**
513
+ *
514
+ * @summary Put Run Custom Metadata
515
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
516
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
517
+ * @param {*} [options] Override http request option.
518
+ * @throws {RequiredError}
519
+ */
520
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut: async (runId, customMetadataUpdateRequest, options = {}) => {
521
+ assertParamExists("putRunCustomMetadataV1RunsRunIdCustomMetadataPut", "runId", runId);
522
+ assertParamExists("putRunCustomMetadataV1RunsRunIdCustomMetadataPut", "customMetadataUpdateRequest", customMetadataUpdateRequest);
523
+ const localVarPath = `/v1/runs/{run_id}/custom-metadata`.replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
524
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
525
+ let baseOptions;
526
+ if (configuration) {
527
+ baseOptions = configuration.baseOptions;
528
+ }
529
+ const localVarRequestOptions = { method: "PUT", ...baseOptions, ...options };
530
+ const localVarHeaderParameter = {};
531
+ const localVarQueryParameter = {};
532
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
533
+ localVarHeaderParameter["Content-Type"] = "application/json";
534
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
535
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
536
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
537
+ localVarRequestOptions.data = serializeDataIfNeeded(customMetadataUpdateRequest, localVarRequestOptions, configuration);
538
+ return {
539
+ url: toPathString(localVarUrlObj),
540
+ options: localVarRequestOptions
541
+ };
542
+ },
543
+ /**
544
+ * Retrieve details of a specific application by its ID.
545
+ * @summary Read Application By Id
546
+ * @param {string} applicationId
547
+ * @param {*} [options] Override http request option.
548
+ * @throws {RequiredError}
549
+ */
550
+ readApplicationByIdV1ApplicationsApplicationIdGet: async (applicationId, options = {}) => {
551
+ assertParamExists("readApplicationByIdV1ApplicationsApplicationIdGet", "applicationId", applicationId);
552
+ const localVarPath = `/v1/applications/{application_id}`.replace(`{${"application_id"}}`, encodeURIComponent(String(applicationId)));
553
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
554
+ let baseOptions;
555
+ if (configuration) {
556
+ baseOptions = configuration.baseOptions;
557
+ }
558
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
559
+ const localVarHeaderParameter = {};
560
+ const localVarQueryParameter = {};
561
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
562
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
563
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
564
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
565
+ return {
566
+ url: toPathString(localVarUrlObj),
567
+ options: localVarRequestOptions
568
+ };
426
569
  }
427
570
  };
428
571
  };
@@ -430,47 +573,75 @@ var PublicApiFp = function(configuration) {
430
573
  const localVarAxiosParamCreator = PublicApiAxiosParamCreator(configuration);
431
574
  return {
432
575
  /**
433
- * 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.
434
- * @summary Cancel Application Run
435
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
576
+ * Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
577
+ * @summary Application Version Details
578
+ * @param {string} applicationId
579
+ * @param {string} version
436
580
  * @param {*} [options] Override http request option.
437
581
  * @throws {RequiredError}
438
582
  */
439
- async cancelApplicationRunV1RunsApplicationRunIdCancelPost(applicationRunId, options) {
440
- const localVarAxiosArgs = await localVarAxiosParamCreator.cancelApplicationRunV1RunsApplicationRunIdCancelPost(applicationRunId, options);
583
+ async applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(applicationId, version, options) {
584
+ const localVarAxiosArgs = await localVarAxiosParamCreator.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(applicationId, version, options);
441
585
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
442
- const localVarOperationServerBasePath = operationServerMap["PublicApi.cancelApplicationRunV1RunsApplicationRunIdCancelPost"]?.[localVarOperationServerIndex]?.url;
586
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet"]?.[localVarOperationServerIndex]?.url;
443
587
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
444
588
  },
445
589
  /**
446
- * 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
447
- * @summary Create Application Run
590
+ * The run can be canceled by the user who created the 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.
591
+ * @summary Cancel Run
592
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
593
+ * @param {*} [options] Override http request option.
594
+ * @throws {RequiredError}
595
+ */
596
+ async cancelRunV1RunsRunIdCancelPost(runId, options) {
597
+ const localVarAxiosArgs = await localVarAxiosParamCreator.cancelRunV1RunsRunIdCancelPost(runId, options);
598
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
599
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.cancelRunV1RunsRunIdCancelPost"]?.[localVarOperationServerIndex]?.url;
600
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
601
+ },
602
+ /**
603
+ * 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 of four, though this number may be reduced during periods of high demand. 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\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_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 (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 an 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) 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 `v1/runs/{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
604
+ * @summary Initiate Run
448
605
  * @param {RunCreationRequest} runCreationRequest
449
606
  * @param {*} [options] Override http request option.
450
607
  * @throws {RequiredError}
451
608
  */
452
- async createApplicationRunV1RunsPost(runCreationRequest, options) {
453
- const localVarAxiosArgs = await localVarAxiosParamCreator.createApplicationRunV1RunsPost(runCreationRequest, options);
609
+ async createRunV1RunsPost(runCreationRequest, options) {
610
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createRunV1RunsPost(runCreationRequest, options);
454
611
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
455
- const localVarOperationServerBasePath = operationServerMap["PublicApi.createApplicationRunV1RunsPost"]?.[localVarOperationServerIndex]?.url;
612
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.createRunV1RunsPost"]?.[localVarOperationServerIndex]?.url;
456
613
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
457
614
  },
458
615
  /**
459
- * 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.
460
- * @summary Delete Application Run Results
461
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
616
+ * 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 (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
617
+ * @summary Delete Run Items
618
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
462
619
  * @param {*} [options] Override http request option.
463
620
  * @throws {RequiredError}
464
621
  */
465
- async deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(applicationRunId, options) {
466
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(applicationRunId, options);
622
+ async deleteRunItemsV1RunsRunIdArtifactsDelete(runId, options) {
623
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRunItemsV1RunsRunIdArtifactsDelete(runId, options);
467
624
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
468
- const localVarOperationServerBasePath = operationServerMap["PublicApi.deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete"]?.[localVarOperationServerIndex]?.url;
625
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.deleteRunItemsV1RunsRunIdArtifactsDelete"]?.[localVarOperationServerIndex]?.url;
469
626
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
470
627
  },
471
628
  /**
472
- *
473
- * @summary Get Me
629
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
630
+ * @summary Get Item By Run
631
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
632
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
633
+ * @param {*} [options] Override http request option.
634
+ * @throws {RequiredError}
635
+ */
636
+ async getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options) {
637
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getItemByRunV1RunsRunIdItemsExternalIdGet(runId, externalId, options);
638
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
639
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.getItemByRunV1RunsRunIdItemsExternalIdGet"]?.[localVarOperationServerIndex]?.url;
640
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
641
+ },
642
+ /**
643
+ * 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)
644
+ * @summary Get current user
474
645
  * @param {*} [options] Override http request option.
475
646
  * @throws {RequiredError}
476
647
  */
@@ -481,87 +652,113 @@ var PublicApiFp = function(configuration) {
481
652
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
482
653
  },
483
654
  /**
484
- * 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.
485
- * @summary Get Run
486
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
487
- * @param {Array<any> | null} [include]
655
+ * 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 `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
656
+ * @summary Get run details
657
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
488
658
  * @param {*} [options] Override http request option.
489
659
  * @throws {RequiredError}
490
660
  */
491
- async getRunV1RunsApplicationRunIdGet(applicationRunId, include, options) {
492
- const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsApplicationRunIdGet(applicationRunId, include, options);
661
+ async getRunV1RunsRunIdGet(runId, options) {
662
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getRunV1RunsRunIdGet(runId, options);
493
663
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
494
- const localVarOperationServerBasePath = operationServerMap["PublicApi.getRunV1RunsApplicationRunIdGet"]?.[localVarOperationServerIndex]?.url;
664
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.getRunV1RunsRunIdGet"]?.[localVarOperationServerIndex]?.url;
495
665
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
496
666
  },
497
667
  /**
498
- * 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
499
- * @summary List Application Runs
500
- * @param {string | null} [applicationId] Optional application ID filter
501
- * @param {string | null} [applicationVersion] Optional application version filter
502
- * @param {Array<any> | null} [include] Request optional output values. Used internally by the platform
668
+ * 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.
669
+ * @summary List available applications
503
670
  * @param {number} [page]
504
671
  * @param {number} [pageSize]
505
- * @param {Array<string> | null} [sort]
672
+ * @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
506
673
  * @param {*} [options] Override http request option.
507
674
  * @throws {RequiredError}
508
675
  */
509
- async listApplicationRunsV1RunsGet(applicationId, applicationVersion, include, page, pageSize, sort, options) {
510
- const localVarAxiosArgs = await localVarAxiosParamCreator.listApplicationRunsV1RunsGet(applicationId, applicationVersion, include, page, pageSize, sort, options);
676
+ async listApplicationsV1ApplicationsGet(page, pageSize, sort, options) {
677
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listApplicationsV1ApplicationsGet(page, pageSize, sort, options);
511
678
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
512
- const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationRunsV1RunsGet"]?.[localVarOperationServerIndex]?.url;
679
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationsV1ApplicationsGet"]?.[localVarOperationServerIndex]?.url;
513
680
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
514
681
  },
515
682
  /**
516
- * 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.
517
- * @summary List Applications
683
+ * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata 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
684
+ * @summary List Run Items
685
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
686
+ * @param {Array<string> | null} [itemIdIn] Filter for item ids
687
+ * @param {Array<string> | null} [externalIdIn] Filter for items by their external_id from the input payload
688
+ * @param {ItemState | null} [state] Filter items by their state
689
+ * @param {ItemTerminationReason | null} [terminationReason] Filter items by their termination reason. Only applies to TERMINATED items.
690
+ * @param {string | null} [customMetadata] JSONPath expression to filter items by their custom_metadata
518
691
  * @param {number} [page]
519
692
  * @param {number} [pageSize]
520
- * @param {Array<string> | null} [sort]
693
+ * @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;run_id&#x60; - &#x60;external_id&#x60; - &#x60;custom_metadata&#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)
521
694
  * @param {*} [options] Override http request option.
522
695
  * @throws {RequiredError}
523
696
  */
524
- async listApplicationsV1ApplicationsGet(page, pageSize, sort, options) {
525
- const localVarAxiosArgs = await localVarAxiosParamCreator.listApplicationsV1ApplicationsGet(page, pageSize, sort, options);
697
+ async listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options) {
698
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listRunItemsV1RunsRunIdItemsGet(runId, itemIdIn, externalIdIn, state, terminationReason, customMetadata, page, pageSize, sort, options);
526
699
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
527
- const localVarOperationServerBasePath = operationServerMap["PublicApi.listApplicationsV1ApplicationsGet"]?.[localVarOperationServerIndex]?.url;
700
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunItemsV1RunsRunIdItemsGet"]?.[localVarOperationServerIndex]?.url;
528
701
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
529
702
  },
530
703
  /**
531
- * Get the list of the results for the run items
532
- * @summary List Run Results
533
- * @param {string} applicationRunId Application run id, returned by &#x60;POST /runs/&#x60; endpoint
534
- * @param {Array<string> | null} [itemIdIn] Filter for items ids
535
- * @param {Array<string> | null} [referenceIn] Filter for items by their reference from the input payload
536
- * @param {Array<ItemStatus> | null} [statusIn] Filter for items in certain statuses
704
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
705
+ * @summary List Runs
706
+ * @param {string | null} [applicationId] Optional application ID filter
707
+ * @param {string | null} [applicationVersion] Optional Version Name
708
+ * @param {string | null} [externalId] Optionally filter runs by items with this external ID
709
+ * @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, 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 - **Remember to URL-encode the entire JSONPath expression when making HTTP requests**
537
710
  * @param {number} [page]
538
711
  * @param {number} [pageSize]
539
- * @param {Array<string> | null} [sort]
712
+ * @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_version_id&#x60; - &#x60;organization_id&#x60; - &#x60;status&#x60; - &#x60;submitted_at&#x60; - &#x60;submitted_by&#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;status&amp;sort&#x3D;-submitted_at&#x60; - Sort by status, then by time (descending)
713
+ * @param {*} [options] Override http request option.
714
+ * @throws {RequiredError}
715
+ */
716
+ async listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, sort, options) {
717
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listRunsV1RunsGet(applicationId, applicationVersion, externalId, customMetadata, page, pageSize, sort, options);
718
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
719
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunsV1RunsGet"]?.[localVarOperationServerIndex]?.url;
720
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
721
+ },
722
+ /**
723
+ *
724
+ * @summary Put Item Custom Metadata By Run
725
+ * @param {string} runId The run id, returned by &#x60;POST /runs/&#x60; endpoint
726
+ * @param {string} externalId The &#x60;external_id&#x60; that was defined for the item by the customer that triggered the run.
727
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
540
728
  * @param {*} [options] Override http request option.
541
729
  * @throws {RequiredError}
542
730
  */
543
- async listRunResultsV1RunsApplicationRunIdResultsGet(applicationRunId, itemIdIn, referenceIn, statusIn, page, pageSize, sort, options) {
544
- const localVarAxiosArgs = await localVarAxiosParamCreator.listRunResultsV1RunsApplicationRunIdResultsGet(applicationRunId, itemIdIn, referenceIn, statusIn, page, pageSize, sort, options);
731
+ async putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(runId, externalId, customMetadataUpdateRequest, options) {
732
+ const localVarAxiosArgs = await localVarAxiosParamCreator.putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(runId, externalId, customMetadataUpdateRequest, options);
545
733
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
546
- const localVarOperationServerBasePath = operationServerMap["PublicApi.listRunResultsV1RunsApplicationRunIdResultsGet"]?.[localVarOperationServerIndex]?.url;
734
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut"]?.[localVarOperationServerIndex]?.url;
547
735
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
548
736
  },
549
737
  /**
550
- * 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.
551
- * @summary List Versions By Application Id
738
+ *
739
+ * @summary Put Run Custom Metadata
740
+ * @param {string} runId Run id, returned by &#x60;POST /runs/&#x60; endpoint
741
+ * @param {CustomMetadataUpdateRequest} customMetadataUpdateRequest
742
+ * @param {*} [options] Override http request option.
743
+ * @throws {RequiredError}
744
+ */
745
+ async putRunCustomMetadataV1RunsRunIdCustomMetadataPut(runId, customMetadataUpdateRequest, options) {
746
+ const localVarAxiosArgs = await localVarAxiosParamCreator.putRunCustomMetadataV1RunsRunIdCustomMetadataPut(runId, customMetadataUpdateRequest, options);
747
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
748
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.putRunCustomMetadataV1RunsRunIdCustomMetadataPut"]?.[localVarOperationServerIndex]?.url;
749
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
750
+ },
751
+ /**
752
+ * Retrieve details of a specific application by its ID.
753
+ * @summary Read Application By Id
552
754
  * @param {string} applicationId
553
- * @param {number} [page]
554
- * @param {number} [pageSize]
555
- * @param {string | null} [version]
556
- * @param {Array<any> | null} [include]
557
- * @param {Array<string> | null} [sort]
558
755
  * @param {*} [options] Override http request option.
559
756
  * @throws {RequiredError}
560
757
  */
561
- async listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(applicationId, page, pageSize, version, include, sort, options) {
562
- const localVarAxiosArgs = await localVarAxiosParamCreator.listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(applicationId, page, pageSize, version, include, sort, options);
758
+ async readApplicationByIdV1ApplicationsApplicationIdGet(applicationId, options) {
759
+ const localVarAxiosArgs = await localVarAxiosParamCreator.readApplicationByIdV1ApplicationsApplicationIdGet(applicationId, options);
563
760
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
564
- const localVarOperationServerBasePath = operationServerMap["PublicApi.listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet"]?.[localVarOperationServerIndex]?.url;
761
+ const localVarOperationServerBasePath = operationServerMap["PublicApi.readApplicationByIdV1ApplicationsApplicationIdGet"]?.[localVarOperationServerIndex]?.url;
565
762
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
566
763
  }
567
764
  };
@@ -570,67 +767,77 @@ var PublicApiFactory = function(configuration, basePath, axios) {
570
767
  const localVarFp = PublicApiFp(configuration);
571
768
  return {
572
769
  /**
573
- * 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.
574
- * @summary Cancel Application Run
575
- * @param {PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest} requestParameters Request parameters.
770
+ * Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
771
+ * @summary Application Version Details
772
+ * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
576
773
  * @param {*} [options] Override http request option.
577
774
  * @throws {RequiredError}
578
775
  */
579
- cancelApplicationRunV1RunsApplicationRunIdCancelPost(requestParameters, options) {
580
- return localVarFp.cancelApplicationRunV1RunsApplicationRunIdCancelPost(requestParameters.applicationRunId, options).then((request) => request(axios, basePath));
776
+ applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters, options) {
777
+ return localVarFp.applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters.applicationId, requestParameters.version, options).then((request) => request(axios, basePath));
581
778
  },
582
779
  /**
583
- * 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
584
- * @summary Create Application Run
585
- * @param {PublicApiCreateApplicationRunV1RunsPostRequest} requestParameters Request parameters.
780
+ * The run can be canceled by the user who created the 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.
781
+ * @summary Cancel Run
782
+ * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
586
783
  * @param {*} [options] Override http request option.
587
784
  * @throws {RequiredError}
588
785
  */
589
- createApplicationRunV1RunsPost(requestParameters, options) {
590
- return localVarFp.createApplicationRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(axios, basePath));
786
+ cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
787
+ return localVarFp.cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(axios, basePath));
591
788
  },
592
789
  /**
593
- * 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.
594
- * @summary Delete Application Run Results
595
- * @param {PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest} requestParameters Request parameters.
790
+ * 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 of four, though this number may be reduced during periods of high demand. 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\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_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 (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 an 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) 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 `v1/runs/{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
791
+ * @summary Initiate Run
792
+ * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
596
793
  * @param {*} [options] Override http request option.
597
794
  * @throws {RequiredError}
598
795
  */
599
- deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(requestParameters, options) {
600
- return localVarFp.deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(requestParameters.applicationRunId, options).then((request) => request(axios, basePath));
796
+ createRunV1RunsPost(requestParameters, options) {
797
+ return localVarFp.createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(axios, basePath));
601
798
  },
602
799
  /**
603
- *
604
- * @summary Get Me
800
+ * 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 (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
801
+ * @summary Delete Run Items
802
+ * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
605
803
  * @param {*} [options] Override http request option.
606
804
  * @throws {RequiredError}
607
805
  */
608
- getMeV1MeGet(options) {
609
- return localVarFp.getMeV1MeGet(options).then((request) => request(axios, basePath));
806
+ deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters, options) {
807
+ return localVarFp.deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters.runId, options).then((request) => request(axios, basePath));
610
808
  },
611
809
  /**
612
- * 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.
613
- * @summary Get Run
614
- * @param {PublicApiGetRunV1RunsApplicationRunIdGetRequest} requestParameters Request parameters.
810
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
811
+ * @summary Get Item By Run
812
+ * @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
615
813
  * @param {*} [options] Override http request option.
616
814
  * @throws {RequiredError}
617
815
  */
618
- getRunV1RunsApplicationRunIdGet(requestParameters, options) {
619
- return localVarFp.getRunV1RunsApplicationRunIdGet(requestParameters.applicationRunId, requestParameters.include, options).then((request) => request(axios, basePath));
816
+ getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
817
+ return localVarFp.getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(axios, basePath));
620
818
  },
621
819
  /**
622
- * 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
623
- * @summary List Application Runs
624
- * @param {PublicApiListApplicationRunsV1RunsGetRequest} requestParameters Request parameters.
820
+ * 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)
821
+ * @summary Get current user
625
822
  * @param {*} [options] Override http request option.
626
823
  * @throws {RequiredError}
627
824
  */
628
- listApplicationRunsV1RunsGet(requestParameters = {}, options) {
629
- return localVarFp.listApplicationRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.include, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
825
+ getMeV1MeGet(options) {
826
+ return localVarFp.getMeV1MeGet(options).then((request) => request(axios, basePath));
630
827
  },
631
828
  /**
632
- * 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.
633
- * @summary List Applications
829
+ * 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 `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
830
+ * @summary Get run details
831
+ * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
832
+ * @param {*} [options] Override http request option.
833
+ * @throws {RequiredError}
834
+ */
835
+ getRunV1RunsRunIdGet(requestParameters, options) {
836
+ return localVarFp.getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(axios, basePath));
837
+ },
838
+ /**
839
+ * 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.
840
+ * @summary List available applications
634
841
  * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
635
842
  * @param {*} [options] Override http request option.
636
843
  * @throws {RequiredError}
@@ -639,96 +846,137 @@ var PublicApiFactory = function(configuration, basePath, axios) {
639
846
  return localVarFp.listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
640
847
  },
641
848
  /**
642
- * Get the list of the results for the run items
643
- * @summary List Run Results
644
- * @param {PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest} requestParameters Request parameters.
849
+ * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata 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
850
+ * @summary List Run Items
851
+ * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
852
+ * @param {*} [options] Override http request option.
853
+ * @throws {RequiredError}
854
+ */
855
+ listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
856
+ 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));
857
+ },
858
+ /**
859
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
860
+ * @summary List Runs
861
+ * @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
645
862
  * @param {*} [options] Override http request option.
646
863
  * @throws {RequiredError}
647
864
  */
648
- listRunResultsV1RunsApplicationRunIdResultsGet(requestParameters, options) {
649
- return localVarFp.listRunResultsV1RunsApplicationRunIdResultsGet(requestParameters.applicationRunId, requestParameters.itemIdIn, requestParameters.referenceIn, requestParameters.statusIn, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
865
+ listRunsV1RunsGet(requestParameters = {}, options) {
866
+ return localVarFp.listRunsV1RunsGet(requestParameters.applicationId, requestParameters.applicationVersion, requestParameters.externalId, requestParameters.customMetadata, requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(axios, basePath));
650
867
  },
651
868
  /**
652
- * 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.
653
- * @summary List Versions By Application Id
654
- * @param {PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest} requestParameters Request parameters.
869
+ *
870
+ * @summary Put Item Custom Metadata By Run
871
+ * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
872
+ * @param {*} [options] Override http request option.
873
+ * @throws {RequiredError}
874
+ */
875
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters, options) {
876
+ return localVarFp.putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters.runId, requestParameters.externalId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(axios, basePath));
877
+ },
878
+ /**
879
+ *
880
+ * @summary Put Run Custom Metadata
881
+ * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
655
882
  * @param {*} [options] Override http request option.
656
883
  * @throws {RequiredError}
657
884
  */
658
- listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(requestParameters, options) {
659
- return localVarFp.listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(requestParameters.applicationId, requestParameters.page, requestParameters.pageSize, requestParameters.version, requestParameters.include, requestParameters.sort, options).then((request) => request(axios, basePath));
885
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters, options) {
886
+ return localVarFp.putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters.runId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(axios, basePath));
887
+ },
888
+ /**
889
+ * Retrieve details of a specific application by its ID.
890
+ * @summary Read Application By Id
891
+ * @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
892
+ * @param {*} [options] Override http request option.
893
+ * @throws {RequiredError}
894
+ */
895
+ readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
896
+ return localVarFp.readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(axios, basePath));
660
897
  }
661
898
  };
662
899
  };
663
900
  var PublicApi = class extends BaseAPI {
664
901
  /**
665
- * 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.
666
- * @summary Cancel Application Run
667
- * @param {PublicApiCancelApplicationRunV1RunsApplicationRunIdCancelPostRequest} requestParameters Request parameters.
902
+ * Get the application version details Allows caller to retrieve information about application version based on provided application version ID.
903
+ * @summary Application Version Details
904
+ * @param {PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest} requestParameters Request parameters.
668
905
  * @param {*} [options] Override http request option.
669
906
  * @throws {RequiredError}
670
907
  * @memberof PublicApi
671
908
  */
672
- cancelApplicationRunV1RunsApplicationRunIdCancelPost(requestParameters, options) {
673
- return PublicApiFp(this.configuration).cancelApplicationRunV1RunsApplicationRunIdCancelPost(requestParameters.applicationRunId, options).then((request) => request(this.axios, this.basePath));
909
+ applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters, options) {
910
+ return PublicApiFp(this.configuration).applicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGet(requestParameters.applicationId, requestParameters.version, options).then((request) => request(this.axios, this.basePath));
674
911
  }
675
912
  /**
676
- * 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
677
- * @summary Create Application Run
678
- * @param {PublicApiCreateApplicationRunV1RunsPostRequest} requestParameters Request parameters.
913
+ * The run can be canceled by the user who created the 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.
914
+ * @summary Cancel Run
915
+ * @param {PublicApiCancelRunV1RunsRunIdCancelPostRequest} requestParameters Request parameters.
679
916
  * @param {*} [options] Override http request option.
680
917
  * @throws {RequiredError}
681
918
  * @memberof PublicApi
682
919
  */
683
- createApplicationRunV1RunsPost(requestParameters, options) {
684
- return PublicApiFp(this.configuration).createApplicationRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(this.axios, this.basePath));
920
+ cancelRunV1RunsRunIdCancelPost(requestParameters, options) {
921
+ return PublicApiFp(this.configuration).cancelRunV1RunsRunIdCancelPost(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
685
922
  }
686
923
  /**
687
- * 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.
688
- * @summary Delete Application Run Results
689
- * @param {PublicApiDeleteApplicationRunResultsV1RunsApplicationRunIdResultsDeleteRequest} requestParameters Request parameters.
924
+ * 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 of four, though this number may be reduced during periods of high demand. 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\", \"input_artifacts\": [{ \"name\": \"user_slide\", \"download_url\": \"https://...\", \"custom_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 (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 an 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) 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 `v1/runs/{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
925
+ * @summary Initiate Run
926
+ * @param {PublicApiCreateRunV1RunsPostRequest} requestParameters Request parameters.
690
927
  * @param {*} [options] Override http request option.
691
928
  * @throws {RequiredError}
692
929
  * @memberof PublicApi
693
930
  */
694
- deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(requestParameters, options) {
695
- return PublicApiFp(this.configuration).deleteApplicationRunResultsV1RunsApplicationRunIdResultsDelete(requestParameters.applicationRunId, options).then((request) => request(this.axios, this.basePath));
931
+ createRunV1RunsPost(requestParameters, options) {
932
+ return PublicApiFp(this.configuration).createRunV1RunsPost(requestParameters.runCreationRequest, options).then((request) => request(this.axios, this.basePath));
696
933
  }
697
934
  /**
698
- *
699
- * @summary Get Me
935
+ * 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 (PROCESSED, CANCELED_SYSTEM, CANCELED_USER). Note that by default, all artifacts are automatically deleted 30 days after the run finishes, regardless of whether the caller explicitly requests deletion.
936
+ * @summary Delete Run Items
937
+ * @param {PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest} requestParameters Request parameters.
700
938
  * @param {*} [options] Override http request option.
701
939
  * @throws {RequiredError}
702
940
  * @memberof PublicApi
703
941
  */
704
- getMeV1MeGet(options) {
705
- return PublicApiFp(this.configuration).getMeV1MeGet(options).then((request) => request(this.axios, this.basePath));
942
+ deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters, options) {
943
+ return PublicApiFp(this.configuration).deleteRunItemsV1RunsRunIdArtifactsDelete(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
706
944
  }
707
945
  /**
708
- * 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.
709
- * @summary Get Run
710
- * @param {PublicApiGetRunV1RunsApplicationRunIdGetRequest} requestParameters Request parameters.
946
+ * Retrieve details of a specific item (slide) by its external ID and the run ID.
947
+ * @summary Get Item By Run
948
+ * @param {PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest} requestParameters Request parameters.
711
949
  * @param {*} [options] Override http request option.
712
950
  * @throws {RequiredError}
713
951
  * @memberof PublicApi
714
952
  */
715
- getRunV1RunsApplicationRunIdGet(requestParameters, options) {
716
- return PublicApiFp(this.configuration).getRunV1RunsApplicationRunIdGet(requestParameters.applicationRunId, requestParameters.include, options).then((request) => request(this.axios, this.basePath));
953
+ getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters, options) {
954
+ return PublicApiFp(this.configuration).getItemByRunV1RunsRunIdItemsExternalIdGet(requestParameters.runId, requestParameters.externalId, options).then((request) => request(this.axios, this.basePath));
717
955
  }
718
956
  /**
719
- * 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
720
- * @summary List Application Runs
721
- * @param {PublicApiListApplicationRunsV1RunsGetRequest} requestParameters Request parameters.
957
+ * 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)
958
+ * @summary Get current user
722
959
  * @param {*} [options] Override http request option.
723
960
  * @throws {RequiredError}
724
961
  * @memberof PublicApi
725
962
  */
726
- listApplicationRunsV1RunsGet(requestParameters = {}, options) {
727
- 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));
963
+ getMeV1MeGet(options) {
964
+ return PublicApiFp(this.configuration).getMeV1MeGet(options).then((request) => request(this.axios, this.basePath));
965
+ }
966
+ /**
967
+ * 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 `/runs/` endpoint. To download the output results, use GET `/runs/{run_id}/` items to get outputs for all slides. Access to a run is restricted to the user who created it.
968
+ * @summary Get run details
969
+ * @param {PublicApiGetRunV1RunsRunIdGetRequest} requestParameters Request parameters.
970
+ * @param {*} [options] Override http request option.
971
+ * @throws {RequiredError}
972
+ * @memberof PublicApi
973
+ */
974
+ getRunV1RunsRunIdGet(requestParameters, options) {
975
+ return PublicApiFp(this.configuration).getRunV1RunsRunIdGet(requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
728
976
  }
729
977
  /**
730
- * 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.
731
- * @summary List Applications
978
+ * 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.
979
+ * @summary List available applications
732
980
  * @param {PublicApiListApplicationsV1ApplicationsGetRequest} requestParameters Request parameters.
733
981
  * @param {*} [options] Override http request option.
734
982
  * @throws {RequiredError}
@@ -738,26 +986,59 @@ var PublicApi = class extends BaseAPI {
738
986
  return PublicApiFp(this.configuration).listApplicationsV1ApplicationsGet(requestParameters.page, requestParameters.pageSize, requestParameters.sort, options).then((request) => request(this.axios, this.basePath));
739
987
  }
740
988
  /**
741
- * Get the list of the results for the run items
742
- * @summary List Run Results
743
- * @param {PublicApiListRunResultsV1RunsApplicationRunIdResultsGetRequest} requestParameters Request parameters.
989
+ * List items in a run with filtering, sorting, and pagination capabilities. Returns paginated items within a specific run. Results can be filtered by item IDs, external_ids, status, and custom_metadata 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
990
+ * @summary List Run Items
991
+ * @param {PublicApiListRunItemsV1RunsRunIdItemsGetRequest} requestParameters Request parameters.
992
+ * @param {*} [options] Override http request option.
993
+ * @throws {RequiredError}
994
+ * @memberof PublicApi
995
+ */
996
+ listRunItemsV1RunsRunIdItemsGet(requestParameters, options) {
997
+ 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));
998
+ }
999
+ /**
1000
+ * List runs with filtering, sorting, and pagination capabilities. Returns paginated runs that were submitted by the user.
1001
+ * @summary List Runs
1002
+ * @param {PublicApiListRunsV1RunsGetRequest} requestParameters Request parameters.
1003
+ * @param {*} [options] Override http request option.
1004
+ * @throws {RequiredError}
1005
+ * @memberof PublicApi
1006
+ */
1007
+ listRunsV1RunsGet(requestParameters = {}, options) {
1008
+ 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));
1009
+ }
1010
+ /**
1011
+ *
1012
+ * @summary Put Item Custom Metadata By Run
1013
+ * @param {PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest} requestParameters Request parameters.
744
1014
  * @param {*} [options] Override http request option.
745
1015
  * @throws {RequiredError}
746
1016
  * @memberof PublicApi
747
1017
  */
748
- listRunResultsV1RunsApplicationRunIdResultsGet(requestParameters, options) {
749
- 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));
1018
+ putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters, options) {
1019
+ return PublicApiFp(this.configuration).putItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPut(requestParameters.runId, requestParameters.externalId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(this.axios, this.basePath));
750
1020
  }
751
1021
  /**
752
- * 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.
753
- * @summary List Versions By Application Id
754
- * @param {PublicApiListVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGetRequest} requestParameters Request parameters.
1022
+ *
1023
+ * @summary Put Run Custom Metadata
1024
+ * @param {PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest} requestParameters Request parameters.
755
1025
  * @param {*} [options] Override http request option.
756
1026
  * @throws {RequiredError}
757
1027
  * @memberof PublicApi
758
1028
  */
759
- listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet(requestParameters, options) {
760
- 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));
1029
+ putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters, options) {
1030
+ return PublicApiFp(this.configuration).putRunCustomMetadataV1RunsRunIdCustomMetadataPut(requestParameters.runId, requestParameters.customMetadataUpdateRequest, options).then((request) => request(this.axios, this.basePath));
1031
+ }
1032
+ /**
1033
+ * Retrieve details of a specific application by its ID.
1034
+ * @summary Read Application By Id
1035
+ * @param {PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest} requestParameters Request parameters.
1036
+ * @param {*} [options] Override http request option.
1037
+ * @throws {RequiredError}
1038
+ * @memberof PublicApi
1039
+ */
1040
+ readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters, options) {
1041
+ return PublicApiFp(this.configuration).readApplicationByIdV1ApplicationsApplicationIdGet(requestParameters.applicationId, options).then((request) => request(this.axios, this.basePath));
761
1042
  }
762
1043
  };
763
1044
 
@@ -1073,36 +1354,39 @@ var PlatformSDKHttp = class {
1073
1354
  }
1074
1355
  }
1075
1356
  /**
1076
- * Retrieve all versions of a specific application
1357
+ * Retrieve detailed information about a specific application
1077
1358
  *
1078
- * This method fetches all available versions for a given application ID.
1079
- * Application versions represent different iterations or configurations of
1080
- * an AI model, allowing you to choose specific versions for processing.
1359
+ * This method fetches comprehensive details about an application, including
1360
+ * its name, description, regulatory classes, and all available versions.
1361
+ * This provides more detailed information compared to the summary returned
1362
+ * by `listApplications()`.
1081
1363
  *
1082
- * @param applicationId - The unique identifier of the application
1083
- * @returns A promise that resolves to an array of application version objects
1084
- * @throws {AuthenticationError} If no valid authentication token is available
1085
- * @throws {Error} If the request fails due to network issues, invalid application ID, or API errors
1364
+ * @param applicationId - The unique identifier of the application to retrieve
1365
+ * @returns A promise that resolves to the complete application details
1366
+ * @throws {Error} If the request fails due to network issues, authentication problems, invalid application ID, or API errors
1086
1367
  *
1087
1368
  * @example
1088
1369
  * ```typescript
1089
1370
  * const sdk = new PlatformSDKHttp({ tokenProvider: () => 'your-token' });
1090
1371
  *
1091
1372
  * try {
1092
- * const versions = await sdk.listApplicationVersions('app-123');
1093
- * console.log(`Found ${versions.length} versions for application`);
1094
- * versions.forEach(version => {
1095
- * console.log(`- Version ${version.version} (ID: ${version.id})`);
1373
+ * const application = await sdk.getApplication('app-123');
1374
+ * console.log(`Application: ${application.name}`);
1375
+ * console.log(`Description: ${application.description}`);
1376
+ * console.log(`Available versions: ${application.versions.length}`);
1377
+ *
1378
+ * application.versions.forEach(version => {
1379
+ * console.log(`- ${version.version} (ID: ${version.application_version_id})`);
1096
1380
  * });
1097
1381
  * } catch (error) {
1098
- * console.error('Failed to list application versions:', error.message);
1382
+ * console.error('Failed to get application details:', error.message);
1099
1383
  * }
1100
1384
  * ```
1101
1385
  */
1102
- async listApplicationVersions(applicationId) {
1386
+ async getApplication(applicationId) {
1103
1387
  const client = await this.#getClient();
1104
1388
  try {
1105
- const response = await client.listVersionsByApplicationIdV1ApplicationsApplicationIdVersionsGet({
1389
+ const response = await client.readApplicationByIdV1ApplicationsApplicationIdGet({
1106
1390
  applicationId
1107
1391
  });
1108
1392
  return response.data;
@@ -1151,7 +1435,7 @@ var PlatformSDKHttp = class {
1151
1435
  async listApplicationRuns(options) {
1152
1436
  const client = await this.#getClient();
1153
1437
  try {
1154
- const response = await client.listApplicationRunsV1RunsGet({
1438
+ const response = await client.listRunsV1RunsGet({
1155
1439
  applicationId: options?.applicationId,
1156
1440
  applicationVersion: options?.applicationVersion
1157
1441
  });
@@ -1201,7 +1485,7 @@ var PlatformSDKHttp = class {
1201
1485
  async createApplicationRun(request) {
1202
1486
  const client = await this.#getClient();
1203
1487
  try {
1204
- const response = await client.createApplicationRunV1RunsPost({
1488
+ const response = await client.createRunV1RunsPost({
1205
1489
  runCreationRequest: request
1206
1490
  });
1207
1491
  return response.data;
@@ -1237,8 +1521,8 @@ var PlatformSDKHttp = class {
1237
1521
  async getRun(applicationRunId) {
1238
1522
  const client = await this.#getClient();
1239
1523
  try {
1240
- const response = await client.getRunV1RunsApplicationRunIdGet({
1241
- applicationRunId
1524
+ const response = await client.getRunV1RunsRunIdGet({
1525
+ runId: applicationRunId
1242
1526
  });
1243
1527
  return response.data;
1244
1528
  } catch (error) {
@@ -1275,8 +1559,8 @@ var PlatformSDKHttp = class {
1275
1559
  async cancelApplicationRun(applicationRunId) {
1276
1560
  const client = await this.#getClient();
1277
1561
  try {
1278
- await client.cancelApplicationRunV1RunsApplicationRunIdCancelPost({
1279
- applicationRunId
1562
+ await client.cancelRunV1RunsRunIdCancelPost({
1563
+ runId: applicationRunId
1280
1564
  });
1281
1565
  } catch (error) {
1282
1566
  handleRequestError(error);
@@ -1315,8 +1599,8 @@ var PlatformSDKHttp = class {
1315
1599
  async listRunResults(applicationRunId) {
1316
1600
  const client = await this.#getClient();
1317
1601
  try {
1318
- const response = await client.listRunResultsV1RunsApplicationRunIdResultsGet({
1319
- applicationRunId
1602
+ const response = await client.listRunItemsV1RunsRunIdItemsGet({
1603
+ runId: applicationRunId
1320
1604
  });
1321
1605
  return response.data;
1322
1606
  } catch (error) {
@@ -1370,6 +1654,6 @@ var PlatformSDKHttp = class {
1370
1654
  // src/index.ts
1371
1655
  var index_default = PlatformSDKHttp;
1372
1656
 
1373
- export { APIError, ApplicationRunStatus, AuthenticationError, BaseError, Configuration, ConfigurationError, ItemStatus, OutputArtifactScope, PlatformSDKHttp, PublicApi, PublicApiAxiosParamCreator, PublicApiFactory, PublicApiFp, index_default as default };
1657
+ export { APIError, ArtifactOutput, ArtifactState, ArtifactTerminationReason, AuthenticationError, BaseError, Configuration, ConfigurationError, ItemOutput, ItemState, ItemTerminationReason, OutputArtifactScope, OutputArtifactVisibility, PlatformSDKHttp, PublicApi, PublicApiAxiosParamCreator, PublicApiFactory, PublicApiFp, RunOutput, RunState, RunTerminationReason, index_default as default };
1374
1658
  //# sourceMappingURL=index.js.map
1375
1659
  //# sourceMappingURL=index.js.map