{"swagger": "2.0", "basePath": "/", "paths": {"/v1/apis/{api_id}/baselineData": {"parameters": [{"name": "api_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "summary": "Get baseline data for given api_id", "operationId": "Show a list of all baseline data given api_id", "parameters": [{"name": "type", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: OWNER, REVIEW, GOLD_WORKFLOW"}, {"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "includeLabel", "in": "query", "type": "boolean", "default": true}], "security": [{"apiToken": []}], "tags": ["baseline data"]}, "post": {"responses": {"200": {"description": "Success"}}, "summary": "Create a new baseline data for a given api_id", "operationId": "create a new baseline data", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BaselineDataInput"}}], "security": [{"apiToken": []}], "tags": ["baseline data"]}}, "/v1/apis/{api_id}/baselineData/job/{job_id}": {"parameters": [{"name": "api_id", "in": "path", "required": true, "type": "string"}, {"name": "job_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"200": {"description": "Success"}}, "summary": "Create a baseline data from a completed job", "operationId": "create a new baseline data from a completed job", "security": [{"apiToken": []}], "tags": ["baseline data"]}}, "/v1/apis/{api_id}/baselineData/{baseline_data_id}": {"parameters": [{"name": "api_id", "in": "path", "required": true, "type": "string"}, {"name": "baseline_data_id", "in": "path", "required": true, "type": "integer"}], "patch": {"responses": {"200": {"description": "Success"}}, "summary": "Patch baseline data given an id and api_id", "operationId": "update baseline data", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BaselineDataInput"}}], "security": [{"apiToken": []}], "tags": ["baseline data"]}, "delete": {"responses": {"200": {"description": "Success"}}, "summary": "Delete baseline data", "operationId": "delete a given baseline data by id", "security": [{"apiToken": []}], "tags": ["baseline data"]}}, "/v1/apis/{api_id}/metrics": {"parameters": [{"name": "api_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "summary": "Get latest metrics of this API", "operationId": "show metrics given the parameters", "security": [{"apiToken": []}], "tags": ["metrics"]}, "put": {"responses": {"200": {"description": "Success"}}, "summary": "Put desired metrics", "operationId": "PUT desired metrics", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DesiredAppMetrics"}}], "security": [{"apiToken": []}], "tags": ["metrics"]}}, "/v1/app/apps/{app_id}/tags": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}}, "summary": "Get application tags", "operationId": "get_app_tags", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "tagContains", "in": "query", "type": "string"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/app/apps/{app_id}/tags/{tag}": {"parameters": [{"in": "path", "description": "The app tag", "name": "tag", "required": true, "type": "string"}, {"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "put": {"responses": {"404": {"description": "App not found"}}, "summary": "Create application  tag", "operationId": "create application tag", "security": [{"apiToken": []}], "tags": ["app instances"]}, "get": {"responses": {"404": {"description": "App not found"}}, "summary": "Get application tag", "operationId": "get_app_tag", "security": [{"apiToken": []}], "tags": ["app instances"]}, "patch": {"responses": {"404": {"description": "App not found"}}, "summary": "Update  application tag", "operationId": "update application tag", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppTagInput"}}], "security": [{"apiToken": []}], "tags": ["app instances"]}, "delete": {"responses": {"404": {"description": "App not found"}, "204": {"description": "Tag deleted"}}, "summary": "Delete application tag", "operationId": "delete_app_tag", "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/app/{app_uuid}/worker-groups": {"parameters": [{"name": "app_uuid", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerGroupAppList"}}}, "summary": "Get worker groups of app", "operationId": "get_worker_groups_app", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["worker groups"]}}, "/v1/app/{app_uuid}/worker-groups/{worker_group_id}": {"parameters": [{"name": "app_uuid", "in": "path", "required": true, "type": "string"}, {"name": "worker_group_id", "in": "path", "required": true, "type": "integer"}], "delete": {"responses": {"204": {"description": "Worker group from app removed"}}, "summary": "Delete worker group from app", "operationId": "delete_worker_group_app", "security": [{"apiToken": []}], "tags": ["worker groups"]}, "patch": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerGroupApp"}}}, "summary": "Update worker group app role", "operationId": "update_worker_group_app", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateWorkerGroupApp"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["worker groups"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerGroupApp"}}}, "summary": "Add worker group to app", "operationId": "get_worker_group_app", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateWorkerGroupApp"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["worker groups"]}}, "/v1/app/{app_uuid}/workers": {"parameters": [{"name": "app_uuid", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerAppList"}}}, "summary": "Get workers of app", "operationId": "get_workers_app", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["workers"]}}, "/v1/app/{app_uuid}/workers/by-username/{username}": {"parameters": [{"name": "app_uuid", "in": "path", "required": true, "type": "string"}, {"name": "username", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerApp"}}}, "summary": "Get worker for app by username", "operationId": "get_worker_app_by_username", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["workers"]}}, "/v1/app/{app_uuid}/workers/{worker_id}": {"parameters": [{"name": "app_uuid", "in": "path", "required": true, "type": "string"}, {"name": "worker_id", "in": "path", "required": true, "type": "integer"}], "delete": {"responses": {"204": {"description": "Worker removed"}}, "summary": "Delete worker from app", "operationId": "delete_worker_app", "security": [{"apiToken": []}], "tags": ["workers"]}, "patch": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerApp"}}}, "summary": "Update worker app role", "operationId": "update_worker_app", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateWorkerApp"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["workers"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerApp"}}}, "summary": "Add worker to app", "operationId": "post_worker_app", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateWorkerApp"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["workers"]}}, "/v1/apps": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/AppsReturn"}}}, "summary": "List all apps", "operationId": "list_apps", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "searchTerm", "in": "query", "type": "string"}, {"name": "workflowName", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}, "post": {"responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/App"}}}, "summary": "Create a new app", "operationId": "create_app", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppInput"}}, {"name": "org", "in": "query", "type": "string"}, {"name": "createWorker", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/job-score-exists/{app_id}": {"parameters": [{"in": "path", "description": "App identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}}, "summary": "check if model confidence score is available for the app", "operationId": "job_score_exists", "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/job_responses_link/{filename}": {"parameters": [{"name": "filename", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Job response file not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppJobResponsesLink"}}}, "summary": "Download job data generated by task", "operationId": "_jobs_response_link", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/owner-activity/{app_id}": {"parameters": [{"in": "path", "description": "App identifier", "name": "app_id", "required": true, "type": "string"}], "put": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/OwnerActivity"}}}, "summary": "update Owner activity for an app", "operationId": "owner_activity", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/App"}}}, "summary": "Fetch a given resource", "operationId": "get_app", "parameters": [{"name": "jobStats", "in": "query", "type": "boolean", "default": true}, {"name": "withSuperTasks", "in": "query", "type": "boolean", "default": false}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}, "patch": {"responses": {"404": {"description": "App not found"}, "202": {"description": "Success", "schema": {"$ref": "#/definitions/AppBatchIdOperationId"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppBatchIdOperationId"}}}, "summary": "Patch an app given its identifier", "operationId": "patch_app", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppInput"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/all_metrics": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/MeasurerMetric"}}}}, "summary": "Get all measurer metrics", "operationId": "get all measurer metrics", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["metrics"]}}, "/v1/apps/{app_id}/cancel": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobCanceled"}}, "202": {"description": "Success", "schema": {"$ref": "#/definitions/JobCanceled"}}}, "summary": "Cancel all jobs in app given app identifier and filters", "operationId": "cancel_app_jobs", "parameters": [{"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: SCHEDULED, IN_PROGRESS, SUSPENDED, PENDING"}, {"name": "inputSearch", "in": "query", "type": "string"}, {"name": "idSearch", "in": "query", "type": "string"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "useTagGroups", "in": "query", "type": "boolean", "default": false}, {"name": "metadataSearch", "in": "query", "type": "string"}, {"name": "idGreaterThan", "in": "query", "type": "integer"}, {"name": "idLessThan", "in": "query", "type": "integer"}, {"name": "inputPath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "inputValue", "in": "query", "type": "string"}, {"name": "inputMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "batchId", "in": "query", "type": "string"}, {"name": "feedbackSearch", "in": "query", "type": "string"}, {"name": "feedbackTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "onlyIfFeedback", "in": "query", "type": "boolean"}, {"name": "firstIncorrect", "in": "query", "type": "boolean"}, {"name": "edited", "in": "query", "type": "boolean"}, {"name": "relabeled", "in": "query", "type": "boolean"}, {"name": "scoreGreaterThan", "in": "query", "type": "number"}, {"name": "scoreLessThan", "in": "query", "type": "number"}, {"name": "trustScoreGreaterThan", "in": "query", "type": "number"}, {"name": "trustScoreLessThan", "in": "query", "type": "number"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/clone": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/App"}}}, "summary": "Clone app", "operationId": "clone_app", "parameters": [{"in": "query", "description": "The strategy to use for cloning the app. Can be one of: FULL_COPY, ORGANIZATION_OWNED_COPY, MEMBER_OWNED_COPY, SYS_ADMIN", "name": "cloneMode", "type": "string", "default": "FULL_COPY", "enum": ["FULL_COPY", "ORGANIZATION_OWNED_COPY", "MEMBER_OWNED_COPY", "SYS_ADMIN"]}, {"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppClone"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/delete_jobs": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "delete": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobDeleted"}}, "202": {"description": "Success", "schema": {"$ref": "#/definitions/JobDeleted"}}}, "summary": "Delete all jobs in app given app identifier and filters", "operationId": "delete_app_jobs", "parameters": [{"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "useTagGroups", "in": "query", "type": "boolean", "default": false}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: SCHEDULED, IN_PROGRESS, FAILED, SUSPENDED, CANCELED, EXPIRED, COMPLETED"}, {"name": "correct", "in": "query", "type": "string"}, {"name": "reviewed", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "inputSearch", "in": "query", "type": "string"}, {"name": "responseSearch", "in": "query", "type": "string"}, {"name": "idSearch", "in": "query", "type": "string"}, {"name": "metadataSearch", "in": "query", "type": "string"}, {"name": "idGreaterThan", "in": "query", "type": "integer"}, {"name": "idLessThan", "in": "query", "type": "integer"}, {"name": "inputPath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "inputValue", "in": "query", "type": "string"}, {"name": "inputMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "responsePath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "responseValue", "in": "query", "type": "string"}, {"name": "responseMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "batchId", "in": "query", "type": "string"}, {"name": "feedbackSearch", "in": "query", "type": "string"}, {"name": "feedbackTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "onlyIfFeedback", "in": "query", "type": "boolean"}, {"name": "firstIncorrect", "in": "query", "type": "boolean"}, {"name": "edited", "in": "query", "type": "boolean"}, {"name": "relabeled", "in": "query", "type": "boolean"}, {"name": "scoreGreaterThan", "in": "query", "type": "number"}, {"name": "scoreLessThan", "in": "query", "type": "number"}, {"name": "trustScoreGreaterThan", "in": "query", "type": "number"}, {"name": "trustScoreLessThan", "in": "query", "type": "number"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/job-feedback-stats": {"parameters": [{"in": "path", "description": "App identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobFeedbackTagStats"}}}, "summary": "Get Job with feedback stats for app id", "operationId": "get_job_with_feedback_stats", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/job_responses": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "App not found"}, "202": {"description": "Success", "schema": {"$ref": "#/definitions/AppDownloadJobs"}}}, "summary": "Fire an async task to get all data", "operationId": "post_task_to_get_jobs_from_app", "parameters": [{"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values : SCHEDULED, IN_PROGRESS, FAILED, SUSPENDED, CANCELED, EXPIRED, COMPLETED"}, {"name": "correct", "in": "query", "type": "string", "description": "Available values: true, false, null"}, {"name": "reviewed", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: CORRECT, NOT_CORRECT, REVIEWED"}, {"name": "inputSearch", "in": "query", "type": "string"}, {"name": "responseSearch", "in": "query", "type": "string"}, {"name": "idSearch", "in": "query", "type": "string"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "useTagGroups", "in": "query", "type": "boolean", "default": false}, {"name": "metadataSearch", "in": "query", "type": "string"}, {"name": "idGreaterThan", "in": "query", "type": "integer"}, {"name": "idLessThan", "in": "query", "type": "integer"}, {"name": "batchId", "in": "query", "type": "string"}, {"name": "csv", "in": "query", "type": "boolean"}, {"name": "flattenedOutput", "in": "query", "type": "boolean", "default": true}, {"name": "inputPath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "inputValue", "in": "query", "type": "string"}, {"name": "inputMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "responsePath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "responseValue", "in": "query", "type": "string"}, {"name": "responseMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "withFeedback", "in": "query", "type": "boolean"}, {"name": "withHistory", "in": "query", "type": "boolean"}, {"name": "onlyIfFeedback", "in": "query", "type": "boolean"}, {"name": "feedbackSearch", "in": "query", "type": "string"}, {"name": "feedbackTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "firstIncorrect", "in": "query", "type": "boolean"}, {"name": "edited", "in": "query", "type": "boolean"}, {"name": "relabeled", "in": "query", "type": "boolean"}, {"name": "scoreGreaterThan", "in": "query", "type": "number"}, {"name": "scoreLessThan", "in": "query", "type": "number"}, {"name": "trustScoreGreaterThan", "in": "query", "type": "number"}, {"name": "trustScoreLessThan", "in": "query", "type": "number"}, {"name": "sendEmail", "in": "query", "type": "boolean"}, {"name": "jobIds", "in": "query", "type": "array", "items": {"type": "integer"}, "collectionFormat": "multi"}, {"name": "flattenTables", "in": "query", "type": "boolean"}, {"name": "annotationPostfixKeys", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "excludeHeaderRow", "in": "query", "type": "boolean"}, {"name": "fieldDelimiter", "in": "query", "type": "string", "description": "Available values: [ , ] ( Comma ), [ ; ] ( Semicolon ), [ | ] ( Pipe )"}, {"name": "quoteValues", "in": "query", "type": "boolean"}, {"name": "fileName", "in": "query", "type": "string"}, {"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppInstanceEmail"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/jobs": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/JobsList"}}}, "summary": "Shows a list of all jobs, within app app_id [TAG ATTRIBUTE IS MOCK]", "operationId": "list_jobs", "parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string", "description": "Application id"}, {"name": "page", "in": "query", "type": "integer", "default": 0, "description": "Page number"}, {"name": "size", "in": "query", "type": "integer", "default": 10, "description": "Size of page"}, {"name": "sortBy", "in": "query", "type": "string", "default": "id", "description": "Sort parameter"}, {"name": "orderBy", "in": "query", "type": "string", "default": "asc", "description": "Order parameter (asc, desc)"}, {"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "useTagGroups", "in": "query", "type": "boolean", "default": false}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: SCHEDULED, IN_PROGRESS, FAILED, SUSPENDED, CANCELED EXPIRED, COMPLETED"}, {"name": "correct", "in": "query", "type": "string", "description": "Available values: true, false, null"}, {"name": "reviewed", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: CORRECT, NOT_CORRECT, NOT_REVIEWED"}, {"name": "inputSearch", "in": "query", "type": "string"}, {"name": "responseSearch", "in": "query", "type": "string"}, {"name": "idSearch", "in": "query", "type": "string"}, {"name": "metadataSearch", "in": "query", "type": "string"}, {"name": "idGreaterThan", "in": "query", "type": "integer"}, {"name": "idLessThan", "in": "query", "type": "integer"}, {"name": "inputPath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "inputValue", "in": "query", "type": "string"}, {"name": "inputMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "responsePath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "responseValue", "in": "query", "type": "string"}, {"name": "responseMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "onlyIfFeedback", "in": "query", "type": "boolean"}, {"name": "batchId", "in": "query", "type": "string"}, {"name": "feedbackSearch", "in": "query", "type": "string"}, {"name": "feedbackTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "firstIncorrect", "in": "query", "type": "boolean"}, {"name": "edited", "in": "query", "type": "boolean"}, {"name": "relabeled", "in": "query", "type": "boolean"}, {"name": "scoreGreaterThan", "in": "query", "type": "number"}, {"name": "scoreLessThan", "in": "query", "type": "number"}, {"name": "trustScoreGreaterThan", "in": "query", "type": "number"}, {"name": "trustScoreLessThan", "in": "query", "type": "number"}, {"name": "feedbackMessageCreatedBefore", "in": "query", "type": "string", "format": "date-time"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}, "post": {"responses": {"201": {"description": "Jobs Submitted", "schema": {"$ref": "#/definitions/JobSubmitted"}}, "409": {"description": "User must accept MeasurementJobs or User has not selected metrics or performance is being calculated"}, "401": {"description": "Invalid API-KEY"}, "402": {"description": "Upadate payment"}, "400": {"description": "Invalid onboarding code"}, "500": {"description": "Job could not be submitted"}}, "summary": "Create a new job", "operationId": "create_job", "parameters": [{"name": "onboarding", "in": "query", "type": "integer"}, {"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/JobInput"}}, {"name": "app_id", "in": "path", "required": true, "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/jobs/collaborator": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobsList"}}}, "summary": "Get collaborator jobs by app", "operationId": "get_collaborator_jobs", "parameters": [{"name": "page", "in": "query", "type": "integer", "default": 0}, {"name": "size", "in": "query", "type": "integer", "default": 10}, {"name": "sortBy", "in": "query", "type": "string", "default": "id"}, {"name": "orderBy", "in": "query", "type": "string", "default": "asc"}, {"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/jobs/count": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/JobsCountPerState"}}}, "summary": "Get jobs state count by app and filters", "operationId": "jobs_count", "parameters": [{"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "useTagGroups", "in": "query", "type": "boolean", "default": false}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: SCHEDULED, IN_PROGRESS, FAILED, SUSPENDED, CANCELED, EXPIRED, COMPLETED"}, {"name": "correct", "in": "query", "type": "string", "description": "Available values: true, false, null"}, {"name": "reviewed", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: CORRECT, NOT_CORRECT, NOT_REVIEWED"}, {"name": "inputSearch", "in": "query", "type": "string"}, {"name": "responseSearch", "in": "query", "type": "string"}, {"name": "idSearch", "in": "query", "type": "string"}, {"name": "metadataSearch", "in": "query", "type": "string"}, {"name": "idGreaterThan", "in": "query", "type": "integer"}, {"name": "idLessThan", "in": "query", "type": "integer"}, {"name": "inputPath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "inputValue", "in": "query", "type": "string"}, {"name": "inputMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "responsePath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "responseValue", "in": "query", "type": "string"}, {"name": "responseMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "onlyIfFeedback", "in": "query", "type": "boolean"}, {"name": "batchId", "in": "query", "type": "string"}, {"name": "feedbackSearch", "in": "query", "type": "string"}, {"name": "feedbackTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "firstIncorrect", "in": "query", "type": "boolean"}, {"name": "edited", "in": "query", "type": "boolean"}, {"name": "relabeled", "in": "query", "type": "boolean"}, {"name": "scoreGreaterThan", "in": "query", "type": "number"}, {"name": "scoreLessThan", "in": "query", "type": "number"}, {"name": "trustScoreGreaterThan", "in": "query", "type": "number"}, {"name": "trustScoreLessThan", "in": "query", "type": "number"}, {"name": "feedbackMessageCreatedBefore", "in": "query", "type": "string", "format": "date-time"}, {"name": "useCache", "in": "query", "type": "boolean", "description": "Use cache, default true"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/jobs/count-by-processing-state": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/JobsCountPerProcessingState"}}}, "summary": "Fetch the number of jobs grouped by their processing state for a specific application", "description": "Get the count of jobs grouped by their processing state with optional date and tag filters.\nApply filters such as creation/completion dates and tags to refine the results.\n\n**Parameters:**\n    - **app_id** (string): The unique identifier of the application.\n\n**Query Parameters:**\n    - **createdStartDate**: (Optional) ISO 8601 date to filter jobs created on or after this date.\n    - **createdEndDate**: (Optional) ISO 8601 date to filter jobs created on or before this date.\n    - **completedStartDate**: (Optional) ISO 8601 date to filter jobs completed on or after this date.\n    - **completedEndDate**: (Optional) ISO 8601 date to filter jobs completed on or before this date.\n    - **tags**: (Optional) Comma-separated tags to include in the filter.\n    - **notTags**: (Optional) Comma-separated tags to exclude from the filter.\n\n**Response:**\n    - A JSON object containing the counts of jobs grouped by each processing state.", "operationId": "jobs_processing_state_count", "parameters": [{"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time", "description": "Filter jobs created on or after this date (ISO 8601 format)."}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time", "description": "Filter jobs created on or before this date (ISO 8601 format)."}, {"name": "completedStartDate", "in": "query", "type": "string", "format": "date-time", "description": "Filter jobs completed on or after this date (ISO 8601 format)."}, {"name": "completedEndDate", "in": "query", "type": "string", "format": "date-time", "description": "Filter jobs completed on or before this date (ISO 8601 format)."}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Comma-separated tags to include in the filter."}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Comma-separated tags to exclude from the filter."}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/jobs/ids": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/JobIdsList"}}}, "summary": "Get job ids to label", "operationId": "get_job_ids", "parameters": [{"name": "page", "in": "query", "type": "integer", "default": 0}, {"name": "size", "in": "query", "type": "integer", "default": 10}, {"name": "sortBy", "in": "query", "type": "string", "default": "id"}, {"name": "orderBy", "in": "query", "type": "string", "default": "asc"}, {"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "useTagGroups", "in": "query", "type": "boolean", "default": false}, {"name": "inputSearch", "in": "query", "type": "string"}, {"name": "inputPath", "in": "query", "type": "string"}, {"name": "inputValue", "in": "query", "type": "string"}, {"name": "inputMatchType", "in": "query", "type": "string"}, {"name": "idSearch", "in": "query", "type": "string"}, {"name": "metadataSearch", "in": "query", "type": "string"}, {"name": "idGreaterThan", "in": "query", "type": "integer"}, {"name": "idLessThan", "in": "query", "type": "integer"}, {"name": "batchId", "in": "query", "type": "string"}, {"name": "onlyIfFeedback", "in": "query", "type": "boolean"}, {"name": "feedbackSearch", "in": "query", "type": "string"}, {"name": "feedbackTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "firstIncorrect", "in": "query", "type": "boolean"}, {"name": "edited", "in": "query", "type": "boolean"}, {"name": "relabeled", "in": "query", "type": "boolean"}, {"name": "scoreGreaterThan", "in": "query", "type": "number"}, {"name": "scoreLessThan", "in": "query", "type": "number"}, {"name": "trustScoreGreaterThan", "in": "query", "type": "number"}, {"name": "trustScoreLessThan", "in": "query", "type": "number"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/jobs/tags": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "put": {"responses": {"204": {"description": "Tags added"}}, "summary": "Add tags to jobs by app and filters", "operationId": "add_tags_to_jobs", "parameters": [{"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "useTagGroups", "in": "query", "type": "boolean", "default": false}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: SCHEDULED, IN_PROGRESS, FAILED, SUSPENDED, CANCELED, EXPIRED, COMPLETED"}, {"name": "correct", "in": "query", "type": "string", "description": "Available values: true, false, null"}, {"name": "reviewed", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: CORRECT, NOT_CORRECT, NOT_REVIEWED"}, {"name": "inputSearch", "in": "query", "type": "string"}, {"name": "responseSearch", "in": "query", "type": "string"}, {"name": "idSearch", "in": "query", "type": "string"}, {"name": "metadataSearch", "in": "query", "type": "string"}, {"name": "idGreaterThan", "in": "query", "type": "integer"}, {"name": "idLessThan", "in": "query", "type": "integer"}, {"name": "inputPath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "inputValue", "in": "query", "type": "string"}, {"name": "inputMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "responsePath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "responseValue", "in": "query", "type": "string"}, {"name": "responseMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "batchId", "in": "query", "type": "string"}, {"name": "feedbackSearch", "in": "query", "type": "string"}, {"name": "feedbackTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "onlyIfFeedback", "in": "query", "type": "boolean"}, {"name": "firstIncorrect", "in": "query", "type": "boolean"}, {"name": "edited", "in": "query", "type": "boolean"}, {"name": "relabeled", "in": "query", "type": "boolean"}, {"name": "scoreGreaterThan", "in": "query", "type": "number"}, {"name": "scoreLessThan", "in": "query", "type": "number"}, {"name": "trustScoreGreaterThan", "in": "query", "type": "number"}, {"name": "trustScoreLessThan", "in": "query", "type": "number"}, {"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/JobTags"}}], "security": [{"apiToken": []}], "tags": ["jobs"]}, "delete": {"responses": {"204": {"description": "Tags removed"}}, "summary": "Remove tags from jobs by app and filters", "operationId": "remove_tags_to_jobs", "parameters": [{"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "useTagGroups", "in": "query", "type": "boolean", "default": false}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: SCHEDULED, IN_PROGRESS, FAILED, SUSPENDED, CANCELED, EXPIRED, COMPLETED"}, {"name": "correct", "in": "query", "type": "string", "description": "Available values: true, false, null"}, {"name": "reviewed", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: CORRECT, NOT_CORRECT, NOT_REVIEWED"}, {"name": "inputSearch", "in": "query", "type": "string"}, {"name": "responseSearch", "in": "query", "type": "string"}, {"name": "idSearch", "in": "query", "type": "string"}, {"name": "metadataSearch", "in": "query", "type": "string"}, {"name": "idGreaterThan", "in": "query", "type": "integer"}, {"name": "idLessThan", "in": "query", "type": "integer"}, {"name": "inputPath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "inputValue", "in": "query", "type": "string"}, {"name": "inputMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "responsePath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "responseValue", "in": "query", "type": "string"}, {"name": "responseMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "batchId", "in": "query", "type": "string"}, {"name": "feedbackSearch", "in": "query", "type": "string"}, {"name": "feedbackTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "onlyIfFeedback", "in": "query", "type": "boolean"}, {"name": "firstIncorrect", "in": "query", "type": "boolean"}, {"name": "edited", "in": "query", "type": "boolean"}, {"name": "relabeled", "in": "query", "type": "boolean"}, {"name": "scoreGreaterThan", "in": "query", "type": "number"}, {"name": "scoreLessThan", "in": "query", "type": "number"}, {"name": "trustScoreGreaterThan", "in": "query", "type": "number"}, {"name": "trustScoreLessThan", "in": "query", "type": "number"}, {"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/JobTags"}}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/jobs/with-feedback-message": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/JobsWithFeedbackMessageList"}}}, "summary": "Shows a list of all jobs with one recently added feedbackmessage, within app app_id", "operationId": "list_jobs_with_feedback_message", "parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string", "description": "Application id"}, {"name": "page", "in": "query", "type": "integer", "default": 0, "description": "Page number"}, {"name": "size", "in": "query", "type": "integer", "default": 10, "description": "Size of page"}, {"name": "sortBy", "in": "query", "type": "string", "default": "id", "description": "Sort parameter"}, {"name": "orderBy", "in": "query", "type": "string", "default": "asc", "description": "Order parameter (asc, desc)"}, {"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "useTagGroups", "in": "query", "type": "boolean", "default": false}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: SCHEDULED, IN_PROGRESS, FAILED, SUSPENDED, CANCELED, EXPIRED, COMPLETED"}, {"name": "correct", "in": "query", "type": "string", "description": "Available values: true, false, null"}, {"name": "reviewed", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: CORRECT, NOT_CORRECT, NOT_REVIEWED"}, {"name": "inputSearch", "in": "query", "type": "string"}, {"name": "responseSearch", "in": "query", "type": "string"}, {"name": "idSearch", "in": "query", "type": "string"}, {"name": "metadataSearch", "in": "query", "type": "string"}, {"name": "idGreaterThan", "in": "query", "type": "integer"}, {"name": "idLessThan", "in": "query", "type": "integer"}, {"name": "inputPath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "inputValue", "in": "query", "type": "string"}, {"name": "inputMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "responsePath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "responseValue", "in": "query", "type": "string"}, {"name": "responseMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "batchId", "in": "query", "type": "string"}, {"name": "feedbackSearch", "in": "query", "type": "string"}, {"name": "feedbackTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "firstIncorrect", "in": "query", "type": "boolean"}, {"name": "edited", "in": "query", "type": "boolean"}, {"name": "relabeled", "in": "query", "type": "boolean"}, {"name": "scoreGreaterThan", "in": "query", "type": "number"}, {"name": "scoreLessThan", "in": "query", "type": "number"}, {"name": "trustScoreGreaterThan", "in": "query", "type": "number"}, {"name": "trustScoreLessThan", "in": "query", "type": "number"}, {"name": "feedbackMessageCreatedBefore", "in": "query", "type": "string", "format": "date-time"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/label": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found or Job to label not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobCollaborator"}}, "204": {"description": "No job available to label"}}, "summary": "Get collaborator jobs by app to label", "operationId": "get_job_to_label", "parameters": [{"name": "jobId", "in": "query", "type": "integer"}, {"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/labeling/jobs_cost_over_time": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppLabelingJobsTimeOverTime"}}}, "summary": "Get labeling jobs cost over time given an app instance id [MOCK]", "operationId": "get_app_labeling_jobs_cost_over_time", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/labeling/jobs_metrics_over_time": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppLabelingJobsMetricsOverTime"}}}, "summary": "Get labeling jobs metric over time given an app instance id [MOCK]", "operationId": "get_app_labeling_jobs_metrics_over_time", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/labeling/jobs_time_over_time": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppLabelingJobsTimeOverTime"}}}, "summary": "Get labeling jobs time over time given an app instance id [MOCK]", "operationId": "get_app_labeling_jobs_time_over_time", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/labeling/progress": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppLabelingProcessModel"}}}, "summary": "Get labeling progress stats given an app instance id [MOCK]", "operationId": "get_app_labeling_processing", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/labeling/time_left": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppLabelingTimeLeft"}}}, "summary": "Get labeling time left given an app instance id [MOCK]", "operationId": "get_app_labeling_time_left", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/measurer/confidences": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ConfidencesResponse"}}}, "summary": "Get measurements for the given app_id", "operationId": "get confidences for the given app_id and meta ai dataset", "parameters": [{"name": "dataset_id", "in": "query", "type": "string", "required": true, "description": "UUID of the dataset"}, {"name": "max_entries", "in": "query", "type": "integer", "description": "maximum amount of jobs for each field"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["metrics"]}}, "/v1/apps/{app_id}/measurer/configuration": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/MeasurerConfiguration"}}}, "summary": "Get measurer configuration", "operationId": "get measurer configuration", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["metrics"]}, "patch": {"responses": {"204": {"description": "Measurer configuration updated"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/MeasurerConfiguration"}}}, "summary": "Update measurer configuration", "operationId": "update measurer configuration", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/MeasurerConfigurationUpdate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["metrics"]}}, "/v1/apps/{app_id}/measurer/measurements": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/MeasurementResponse"}}}, "summary": "Get measurements for the given app_id", "operationId": "get measurements for the given app_id", "parameters": [{"name": "start_time", "in": "query", "type": "string", "format": "date-time", "description": "Start time for the query period"}, {"name": "end_time", "in": "query", "type": "string", "format": "date-time", "description": "End time for the query period"}, {"name": "parameter_set_id", "in": "query", "type": "string", "description": "UUID of the parameter set"}, {"name": "dataset_id", "in": "query", "type": "string", "description": "UUID of the dataset"}, {"name": "field_name", "in": "query", "type": "string", "description": "Filter by field name"}, {"name": "metric_name", "in": "query", "type": "string", "description": "Filter by metric name"}, {"name": "group_by", "in": "query", "type": "array", "description": "Group by field name", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["metrics"]}}, "/v1/apps/{app_id}/measurer/operation": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/OperationReturn"}}}}, "summary": "Get all operations for the measurer", "operationId": "get all measurer operations", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["metrics"]}, "post": {"responses": {"400": {"description": "Bad request"}, "201": {"description": "Operation created"}}, "summary": "Create a new operation for the measurer", "operationId": "create a new measurer operation", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/OperationCreate"}}], "security": [{"apiToken": []}], "tags": ["metrics"]}}, "/v1/apps/{app_id}/measurer/operation/{operation_id}": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}, {"name": "operation_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OperationReturn"}}}, "summary": "Get a specific operation for the measurer", "operationId": "get a specific measurer operation", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["metrics"]}, "delete": {"responses": {"204": {"description": "Operation deleted"}}, "summary": "Delete a specific operation for the measurer", "operationId": "delete a specific measurer operation", "security": [{"apiToken": []}], "tags": ["metrics"]}}, "/v1/apps/{app_id}/measurer/operation/{operation_id}/cancel": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}, {"name": "operation_id", "in": "path", "required": true, "type": "string"}], "patch": {"responses": {"204": {"description": "Operation canceled"}}, "summary": "Cancel a specific operation for the measurer", "operationId": "cancel a specific measurer operation", "security": [{"apiToken": []}], "tags": ["metrics"]}}, "/v1/apps/{app_id}/metrics": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppMetric"}}}}, "summary": "Get measurer app metrics", "operationId": "get measurer app metrics", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["metrics"]}}, "/v1/apps/{app_id}/overview": {"parameters": [{"name": "includeHumansVsAi", "in": "query", "type": "boolean", "default": false}, {"name": "preferCache", "in": "query", "type": "boolean", "default": true}, {"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppOverview"}}}, "summary": "Fetch a given resource", "operationId": "get_app_overview", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/plans_metadata": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppDpWorkflowsMetadata"}}}, "summary": "Get application plans metadata", "operationId": "get_app_plans_metadata", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/relabel": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "App not found"}, "202": {"description": "Success", "schema": {"$ref": "#/definitions/JobSubmittedRelabel"}}}, "summary": "Relabel all jobs in app given app identifier and filters", "operationId": "relabel_app_jobs", "parameters": [{"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "useTagGroups", "in": "query", "type": "boolean", "default": false}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: FAILED, CANCELED, EXPIRED, COMPLETED"}, {"name": "reviewed", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "inputSearch", "in": "query", "type": "string"}, {"name": "responseSearch", "in": "query", "type": "string"}, {"name": "idSearch", "in": "query", "type": "string"}, {"name": "metadataSearch", "in": "query", "type": "string"}, {"name": "idGreaterThan", "in": "query", "type": "integer"}, {"name": "idLessThan", "in": "query", "type": "integer"}, {"name": "inputPath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "inputValue", "in": "query", "type": "string"}, {"name": "inputMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "responsePath", "in": "query", "type": "string", "description": "Format: Use {} for root, {a.b.0} for the json path. The path should be within {}"}, {"name": "responseValue", "in": "query", "type": "string"}, {"name": "responseMatchType", "in": "query", "type": "string", "description": "Available values: IS, IS_NOT, CONTAINS, CONTAINS_NOT, IS_NOT_EMPTY"}, {"name": "batchId", "in": "query", "type": "string"}, {"name": "feedbackSearch", "in": "query", "type": "string"}, {"name": "feedbackTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "onlyIfFeedback", "in": "query", "type": "boolean"}, {"name": "firstIncorrect", "in": "query", "type": "boolean"}, {"name": "edited", "in": "query", "type": "boolean"}, {"name": "relabeled", "in": "query", "type": "boolean"}, {"name": "scoreGreaterThan", "in": "query", "type": "number"}, {"name": "scoreLessThan", "in": "query", "type": "number"}, {"name": "trustScoreGreaterThan", "in": "query", "type": "number"}, {"name": "trustScoreLessThan", "in": "query", "type": "number"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/selected_plan": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSelectedWorkflow"}}}, "summary": "Get application selected plan", "operationId": "get_app_selected_plan", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/start": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "App not found"}, "202": {"description": "Success", "schema": {"$ref": "#/definitions/JobsOperation"}}}, "summary": "Start all jobs in app given app identifier and filters", "operationId": "start_app_jobs", "parameters": [{"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "inputSearch", "in": "query", "type": "string"}, {"name": "idSearch", "in": "query", "type": "string"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "notTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "useTagGroups", "in": "query", "type": "boolean", "default": false}, {"name": "metadataSearch", "in": "query", "type": "string"}, {"name": "idGreaterThan", "in": "query", "type": "integer"}, {"name": "idLessThan", "in": "query", "type": "integer"}, {"name": "inputPath", "in": "query", "type": "string"}, {"name": "inputValue", "in": "query", "type": "string"}, {"name": "inputMatchType", "in": "query", "type": "string"}, {"name": "batchId", "in": "query", "type": "string"}, {"name": "feedbackSearch", "in": "query", "type": "string"}, {"name": "feedbackTags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "onlyIfFeedback", "in": "query", "type": "boolean"}, {"name": "firstIncorrect", "in": "query", "type": "boolean"}, {"name": "edited", "in": "query", "type": "boolean"}, {"name": "relabeled", "in": "query", "type": "boolean"}, {"name": "scoreGreaterThan", "in": "query", "type": "number"}, {"name": "scoreLessThan", "in": "query", "type": "number"}, {"name": "trustScoreGreaterThan", "in": "query", "type": "number"}, {"name": "trustScoreLessThan", "in": "query", "type": "number"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_id}/super-tasks": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSuperTasks"}}}, "summary": "Fetch app super tasks", "operationId": "get_app_super_tasks", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}, "patch": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSuperTasks"}}}, "summary": "Updates app super tasks", "operationId": "patch_app_super_tasks", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSuperTasksUpdate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/task_median_completion": {"parameters": [{"name": "taskNames", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppTaskMedianCompletionTime"}}}, "summary": "Get application tasks median completion", "operationId": "get_app_tasks_median_completion", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/tasks-distribution": {"parameters": [{"name": "preferCache", "in": "query", "type": "boolean", "default": true}, {"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TaskDistribution"}}}, "summary": "Get task worker distribution by app", "operationId": "get_task_distribution", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["task-info"]}}, "/v1/apps/{app_id}/tasks-download": {"parameters": [{"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "csv", "in": "query", "type": "boolean"}, {"name": "flattenedOutput", "in": "query", "type": "boolean"}, {"name": "name", "in": "query", "type": "string"}, {"name": "rootJobIds", "in": "query", "type": "array", "items": {"type": "integer"}, "collectionFormat": "multi"}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppDownloadTasks"}}}, "summary": "Trigger task download operation by app id and filters", "operationId": "tasks_download", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["task-info"]}}, "/v1/apps/{app_id}/template": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Template"}}}, "summary": "Fetch a template given app", "operationId": "get_app_template", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app instances"]}}, "/v1/apps/{app_id}/total_job_count": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "summary": "Total job count including deleted and relabeled", "operationId": "total_job_count", "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_uuid}/batches": {"parameters": [{"in": "path", "description": "The app identifier (uuid)", "name": "app_uuid", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobBatches"}}}, "summary": "Get job batches with optional filtering and paging", "operationId": "get_job_batches", "parameters": [{"name": "page", "in": "query", "type": "integer", "description": "Page number (0-based)"}, {"name": "size", "in": "query", "type": "integer", "description": "Number of items per page"}, {"name": "batch_processed", "in": "query", "type": "boolean", "description": "Filter by batch processed status (true/false)"}, {"name": "created_after", "in": "query", "type": "string", "format": "date-time", "description": "Filter batches created after this ISO timestamp"}, {"name": "created_before", "in": "query", "type": "string", "format": "date-time", "description": "Filter batches created before this ISO timestamp"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_uuid}/batches/{batch_id}": {"parameters": [{"in": "path", "description": "The batch identifier (uuid)", "name": "batch_id", "required": true, "type": "string"}, {"in": "path", "description": "The app identifier (uuid)", "name": "app_uuid", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobBatch"}}}, "summary": "Get job batch", "operationId": "get_job_batch", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_uuid}/batches/{batch_id}/ids": {"parameters": [{"in": "path", "description": "The batch identifier (uuid)", "name": "batch_id", "required": true, "type": "string"}, {"in": "path", "description": "The app identifier (uuid)", "name": "app_uuid", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Batch not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobBatchIds"}}}, "summary": "Get job ids of batch", "operationId": "get_job_batch_ids", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_uuid}/batches/{batch_id}/resubmit": {"parameters": [{"in": "path", "description": "The batch id", "name": "batch_id", "required": true, "type": "string"}, {"in": "path", "description": "The app id", "name": "app_uuid", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "App not found"}}, "summary": "Resubmit job batch", "operationId": "resubmit_job_batch", "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/apps/{app_uuid}/feedbacktags": {"parameters": [{"in": "path", "description": "The app identifier", "name": "app_uuid", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/feedback_tag"}}}}, "summary": "Fetches the feedback tags associated with the app", "operationId": "get_app_feedback_tags", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["jobs"]}}, "/v1/apps/{app_uuid}/jobs/filter": {"parameters": [{"in": "path", "description": "The app identifier (uuid)", "name": "app_uuid", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobsList"}}}, "operationId": "get_jobs_by_ids", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string", "default": "id"}, {"name": "orderBy", "in": "query", "type": "string", "default": "desc"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/backoffice/customers": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CustomerPage"}}}, "summary": "Lists the current customers of super", "description": "AI", "operationId": "list customer", "parameters": [{"name": "searchEmail", "in": "query", "type": "string"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "page", "in": "query", "type": "integer"}, {"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "sortBy", "in": "query", "type": "string", "default": "created"}, {"name": "orderBy", "in": "query", "type": "string", "default": "desc"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"authToken": []}], "tags": ["authentication"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorAccessRole"}}}, "summary": "Invite a collaborator", "operationId": "Invite customer", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CollaboratorCreate"}}, {"name": "createWorker", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"authToken": []}], "tags": ["authentication"]}}, "/v1/backoffice/customers/{customer_email}/apps": {"parameters": [{"name": "customer_email", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/AppsReturn"}}}, "summary": "List all apps of customer", "operationId": "list_customer_apps", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "searchTerm", "in": "query", "type": "string"}, {"name": "workflowName", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["authentication"]}}, "/v1/backoffice/customers/{username}": {"parameters": [{"name": "username", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Customer"}}}, "summary": "Get the customer by email", "operationId": "get customer", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"authToken": []}], "tags": ["authentication"]}, "patch": {"responses": {"200": {"description": "Success"}}, "operationId": "convert/extend customer account", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"type": "object", "properties": {"trialDays": {"type": "string"}, "convertToFullUser": {"type": "string"}}}}], "security": [{"authToken": []}], "tags": ["authentication"]}, "delete": {"responses": {"200": {"description": "Success"}}, "description": "Suspend customer account", "operationId": "delete_backoffice_user", "security": [{"authToken": []}], "tags": ["authentication"]}}, "/v1/baselineData/{baseline_data_id}": {"parameters": [{"name": "baseline_data_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "summary": "Get baseline data given a baseline data id", "operationId": "list given baseline_data_id", "security": [{"apiToken": []}], "tags": ["baseline data"]}, "patch": {"responses": {"200": {"description": "Success"}}, "summary": "Patch baseline data given an id", "operationId": "Patch existing baseline data", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BaselineDataInput"}}], "security": [{"apiToken": []}], "tags": ["baseline data"]}, "delete": {"responses": {"200": {"description": "Success"}}, "summary": "Delete baseline data", "operationId": "delete a given baseline data", "security": [{"apiToken": []}], "tags": ["baseline data"]}}, "/v1/billing/invoices": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/InvoicesList"}}}, "summary": "Get invoices of given owner id", "operationId": "Show invoices of a given owner id", "parameters": [{"name": "periodStart", "in": "query", "type": "string"}, {"name": "periodEnd", "in": "query", "type": "string"}, {"name": "status", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "invoiceId", "in": "query", "type": "array", "items": {"type": "integer"}, "collectionFormat": "multi"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["billing"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/InvoicesList"}}}, "summary": "Create an invoice for a given owner with specified parameters", "operationId": "show invoices for given owner id", "parameters": [{"name": "periodStart", "in": "query", "type": "string"}, {"name": "periodEnd", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["billing"]}}, "/v1/billing/invoices/{invoice_id}": {"parameters": [{"name": "invoice_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/InvoicesList"}}}, "summary": "Get invoice of a given id and owner id", "operationId": "Show invoice of a given owner id of a given invoice id", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["billing"]}}, "/v1/billing/payments": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PaymentMethods"}}}, "summary": "Get available payment methods of a given owner id", "operationId": "Get available payment methods of a given owner id", "parameters": [{"name": "provider", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "status", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "paymentMethodId", "in": "query", "type": "array", "items": {"type": "integer"}, "collectionFormat": "multi"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["billing"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PaymentMethod"}}}, "summary": "Store a new payment method for a given owner id", "operationId": "Store a new payment method for given owner", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PaymentMethodInput"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["billing"]}}, "/v1/billing/payments/charge": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Charges"}}}, "summary": "Query payment charges of a given owner_id", "operationId": "Query payment charges of a given owner_id", "parameters": [{"name": "createdMin", "in": "query", "type": "string"}, {"name": "createdMax", "in": "query", "type": "string"}, {"name": "status", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "chargeId", "in": "query", "type": "array", "items": {"type": "integer"}, "collectionFormat": "multi"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["billing"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Charge"}}}, "summary": "Charge the given payment method for a given owner_id", "operationId": "Charge a payment method of a given owner_id", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ChargeInput"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["billing"]}}, "/v1/billing/payments/{payment_method_id}": {"parameters": [{"name": "payment_method_id", "in": "path", "required": true, "type": "string"}], "patch": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PaymentMethod"}}}, "summary": "Update a given payment methods of a given owner id", "operationId": "Update a given payment methods of a given owner id", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PaymentMethodUpdate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["billing"]}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/PaymentMethod"}}}, "summary": "Delete a given payment methods of a given owner id", "operationId": "Delete a given payment methods of a given owner id", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["billing"]}}, "/v1/collaborator-task-big-payload/by-job/{job_id}/{sequence}/resolved": {"parameters": [{"name": "job_id", "in": "path", "required": true, "type": "string"}, {"name": "sequence", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorTaskBigPayloadResponse"}}}, "summary": "Retrieve resolved collaborator task with big payload by job and sequence", "operationId": "get_collab_task_big_payload_by_job", "parameters": [{"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator tasks"]}}, "/v1/collaborator-task-big-payload/{task_id}": {"parameters": [{"name": "task_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorTaskBigPayloadResponse"}}}, "operationId": "get_stored_collaborator_task_big_payload", "parameters": [{"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "action", "in": "query", "type": "string", "description": "Available values : RESOLVE, STORE"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator tasks"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorTaskBigPayloadResponse"}}}, "operationId": "update_collaborator_task_big_payload", "parameters": [{"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "action", "in": "query", "type": "string", "description": "Available values : RESOLVE, STORE"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator tasks"]}}, "/v1/collaborators": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorList"}}}, "summary": "List collaborations", "operationId": "List collaborations", "parameters": [{"name": "page", "in": "query", "type": "integer", "description": "Page number"}, {"name": "size", "in": "query", "type": "integer", "description": "Size of page"}, {"name": "sortBy", "in": "query", "type": "string", "description": "Sort parameter"}, {"name": "orderBy", "in": "query", "type": "string", "description": "Order parameter (asc, desc)"}, {"description": "Optional id of owner of collaborators", "name": "owner_id", "type": "string", "in": "query"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorAccessRole"}}}, "summary": "Invite a collaborator", "operationId": "Invite collaborator", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CollaboratorCreate"}}, {"name": "createWorker", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator"]}}, "/v1/collaborators/app/{app_id}": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorList"}}}, "summary": "List collaborations", "operationId": "List collaborations by app", "parameters": [{"name": "page", "in": "query", "type": "integer", "description": "Page number"}, {"name": "size", "in": "query", "type": "integer", "description": "Size of page"}, {"name": "sortBy", "in": "query", "type": "string", "description": "Sort parameter"}, {"name": "orderBy", "in": "query", "type": "string", "description": "Order parameter (asc, desc)"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator"]}}, "/v1/collaborators/collaborates-with": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorWithList"}}}, "summary": "List roles of user", "operationId": "List roles of user", "parameters": [{"name": "page", "in": "query", "type": "integer", "description": "Page number"}, {"name": "size", "in": "query", "type": "integer", "description": "Size of page"}, {"name": "sortBy", "in": "query", "type": "string", "description": "Sort parameter"}, {"name": "orderBy", "in": "query", "type": "string", "description": "Order parameter (asc, desc)"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator"]}}, "/v1/collaborators/invitations": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorList"}}}, "summary": "Get invitations", "operationId": "Get invitations", "parameters": [{"name": "page", "in": "query", "type": "integer", "description": "Page number"}, {"name": "size", "in": "query", "type": "integer", "description": "Size of page"}, {"name": "sortBy", "in": "query", "type": "string", "description": "Sort parameter"}, {"name": "orderBy", "in": "query", "type": "string", "description": "Order parameter (asc, desc)"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator"]}}, "/v1/collaborators/metrics": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorMetricsList"}}}, "summary": "Get all collaborators satisfying the given apiId and period range [MOCK]", "operationId": "get_collaborator_metrics", "parameters": [{"name": "apiId", "in": "query", "type": "string"}, {"name": "periodStart", "in": "query", "type": "string"}, {"name": "periodEnd", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["collaborator metrics"]}}, "/v1/collaborators/{collaboration_id}": {"parameters": [{"name": "collaboration_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorAccessRole"}}}, "summary": "Get a collaboration given an id", "operationId": "show a collaboration/invitation by id", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator"]}, "patch": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorAccessRole"}}}, "summary": "Patch a collaboration given an id", "operationId": "patch a collaboration/invitation by id", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CollaboratorUpdate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator"]}, "delete": {"responses": {"204": {"description": "Collaborator deleted"}}, "summary": "Delete a collaborator given an id", "operationId": "delete a collaborator by id", "security": [{"apiToken": []}], "tags": ["collaborator"]}}, "/v1/collaborators/{collaborator_id}/metrics": {"parameters": [{"name": "collaborator_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollaboratorMetricsList"}}}, "summary": "Get the collaborator metrics for given apiId and period range [MOCK]", "operationId": "get_collaborator_metrics_get_id", "parameters": [{"name": "apiId", "in": "query", "type": "string"}, {"name": "periodStart", "in": "query", "type": "string"}, {"name": "periodEnd", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["collaborator metrics"]}}, "/v1/collaborators/{collaborator_id}/user-exists": {"parameters": [{"name": "collaborator_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UserExistsModel"}}}, "summary": "Checks collaborator invite user exists", "operationId": "get_collaborator_invite_user_exists", "parameters": [{"name": "verification_code", "in": "query", "type": "string", "required": true}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator"]}}, "/v1/collaborators/{invitation_id}/accept": {"parameters": [{"name": "invitation_id", "in": "path", "required": true, "type": "integer"}], "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Collaborator"}}}, "summary": "Accept invitation", "operationId": "Accept invitation", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator"]}}, "/v1/collabtaskqueue/in-progress/{app_id}": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/CollabTaskInProgCount"}}}, "operationId": "get_collaborator_tasks_in_progress_count", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["collaborator tasks"]}}, "/v1/collabtaskqueue/label/{app_id}": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "operationId": "get_collaborator_tasks_to_label", "parameters": [{"name": "jobId", "in": "query", "type": "string"}], "security": [{"apiToken": []}], "tags": ["collaborator tasks"]}}, "/v1/collabtaskqueue/task/{task_id}": {"parameters": [{"name": "task_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success"}}, "operationId": "get_collaborator_task", "security": [{"apiToken": []}], "tags": ["collaborator tasks"]}, "patch": {"responses": {"200": {"description": "Success"}}, "operationId": "update_collaborator_task", "parameters": [{"name": "action", "in": "query", "type": "string", "description": "Available values : RESOLVE, REJECT, STORE"}, {"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CollabTaskUpdate"}}], "security": [{"apiToken": []}], "tags": ["collaborator tasks"]}}, "/v1/collabtaskqueue/task/{task_id}/alive": {"parameters": [{"name": "task_id", "in": "path", "required": true, "type": "integer"}], "post": {"responses": {"204": {"description": "Keep alive"}}, "operationId": "post_collaborator_task_alive", "security": [{"apiToken": []}], "tags": ["collaborator tasks"]}}, "/v1/contact": {"post": {"responses": {"204": {"description": "Contact details sent"}}, "summary": "Post contact details", "operationId": "post_contact", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/Contact"}}], "tags": ["contact"]}}, "/v1/data": {"get": {"responses": {"200": {"description": "Success"}}, "summary": "Query data", "operationId": "Query data", "parameters": [{"name": "dataId", "in": "query", "type": "array", "items": {"type": "integer"}, "collectionFormat": "multi"}, {"name": "path", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "pathContains", "in": "query", "type": "string"}, {"name": "pathNotContains", "in": "query", "type": "string"}, {"name": "signedUrl", "in": "query", "type": "boolean"}, {"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "recursive", "in": "query", "type": "boolean", "default": false}], "security": [{"apiToken": []}], "tags": ["data"]}, "delete": {"responses": {"200": {"description": "Success"}}, "summary": "Delete a data", "operationId": "Delete data", "parameters": [{"name": "path", "in": "query", "type": "string"}], "security": [{"apiToken": []}], "tags": ["data"]}, "put": {"responses": {"200": {"description": "Success"}}, "summary": "create/upload new data", "operationId": "Create/Upload data", "parameters": [{"name": "path", "in": "query", "type": "string"}, {"name": "mimeType", "in": "query", "type": "string"}, {"name": "description", "in": "query", "type": "string"}, {"name": "signedUrl", "in": "query", "type": "boolean"}, {"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "uploadUrl", "in": "query", "type": "boolean"}], "security": [{"apiToken": []}], "tags": ["data"]}, "post": {"responses": {"200": {"description": "Success"}}, "summary": "create new data", "operationId": "Create data", "parameters": [{"name": "path", "in": "query", "type": "string", "description": "The path/filename where the data will be stored. If not given, the path will be generated automatically."}, {"name": "mimeType", "in": "query", "type": "string", "description": "The MIME type of the uploaded data."}, {"name": "description", "in": "query", "type": "string", "description": "A brief description of the data being uploaded."}, {"name": "file", "in": "formData", "type": "file", "description": "The file to be uploaded. Either this or uploadUrl is required"}, {"name": "signedUrl", "in": "query", "type": "boolean", "description": "Boolean flag to indicate if a signed URL should be returned to download the file after."}, {"name": "secondsTtl", "in": "query", "type": "integer", "description": "Time-to-live in seconds for the uploaded data."}, {"name": "uploadUrl", "in": "query", "type": "boolean", "description": "Boolean flag to indicate if an upload URL should be returned to upload the file via PUT request. Either this or file is required."}, {"name": "organizationName", "in": "query", "type": "string", "description": "If the user is a member or collaborator of an organization, by providing the organization name, it will upload data in the organization storage."}], "security": [{"apiToken": []}], "consumes": ["multipart/form-data"], "tags": ["data"]}}, "/v1/data/aitask/{ai_task_id}": {"parameters": [{"name": "ai_task_id", "in": "path", "required": true, "type": "integer"}], "post": {"responses": {"200": {"description": "Success"}}, "summary": "Create new AI task data", "operationId": "Create AI task data. Only allows access for AI models.", "parameters": [{"name": "path", "in": "query", "type": "string", "description": "The path/filename where the data will be stored. If not given, the path will be generated automatically."}, {"name": "mimeType", "in": "query", "type": "string", "description": "The MIME type of the uploaded data."}, {"name": "description", "in": "query", "type": "string", "description": "A brief description of the data being uploaded."}, {"name": "file", "in": "formData", "type": "file", "description": "The file to be uploaded. Either this or uploadUrl is required"}, {"name": "signedUrl", "in": "query", "type": "boolean", "description": "Boolean flag to indicate if a signed URL should be returned to download the file after."}, {"name": "secondsTtl", "in": "query", "type": "integer", "description": "Time-to-live in seconds for the uploaded data."}, {"name": "uploadUrl", "in": "query", "type": "boolean", "description": "Boolean flag to indicate if an upload URL should be returned to upload the file via PUT request. Either this or file is required."}, {"name": "organizationName", "in": "query", "type": "string", "description": "If the user is a member or collaborator of an organization, by providing the organization name, it will upload data in the organization storage."}], "security": [{"apiToken": []}], "consumes": ["multipart/form-data"], "tags": ["data"]}}, "/v1/data/collabtask/{task_id}/url": {"parameters": [{"name": "task_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success"}}, "summary": "Generate a signed url for collaborator task data", "operationId": "Generate a signed url for collaborator task data", "parameters": [{"name": "jobId", "in": "query", "type": "integer"}, {"name": "baselineId", "in": "query", "type": "integer"}, {"name": "taskId", "in": "query", "type": "integer"}, {"name": "collabTaskId", "in": "query", "type": "integer"}, {"name": "ownerId", "in": "query", "type": "integer"}, {"name": "path", "in": "query", "type": "string"}, {"name": "secondsTtl", "in": "query", "type": "integer"}], "security": [{"apiToken": []}], "tags": ["data"]}}, "/v1/data/url": {"get": {"responses": {"200": {"description": "Success"}}, "summary": "Generate signed url for given data name and ttl", "operationId": "Generate a signed url for owner data", "parameters": [{"name": "jobId", "in": "query", "type": "integer"}, {"name": "baselineId", "in": "query", "type": "integer"}, {"name": "taskId", "in": "query", "type": "integer"}, {"name": "collabTaskId", "in": "query", "type": "integer"}, {"name": "ownerId", "in": "query", "type": "integer"}, {"name": "path", "in": "query", "type": "string"}, {"name": "secondsTtl", "in": "query", "type": "integer"}], "security": [{"apiToken": []}], "tags": ["data"]}}, "/v1/data/{worker_uuid}/training/{training_id}/url": {"parameters": [{"name": "worker_uuid", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success"}}, "summary": "Generate a signed url for task data", "operationId": "Generate a signed url for training example data", "parameters": [{"name": "exampleId", "in": "query", "type": "integer"}, {"name": "sequence", "in": "query", "type": "integer"}, {"name": "path", "in": "query", "type": "string"}, {"name": "ownerId", "in": "query", "type": "integer"}, {"name": "secondsTtl", "in": "query", "type": "integer"}], "security": [{"heroCognitoToken": []}], "tags": ["data"]}}, "/v1/data/{worker_uuid}/{task_id}/url": {"parameters": [{"name": "worker_uuid", "in": "path", "required": true, "type": "string"}, {"name": "task_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success"}}, "summary": "Generate a signed url for task data", "operationId": "Generate a signed url for task data", "parameters": [{"name": "jobId", "in": "query", "type": "integer"}, {"name": "baselineId", "in": "query", "type": "integer"}, {"name": "taskId", "in": "query", "type": "integer"}, {"name": "collabTaskId", "in": "query", "type": "integer"}, {"name": "ownerId", "in": "query", "type": "integer"}, {"name": "path", "in": "query", "type": "string"}, {"name": "secondsTtl", "in": "query", "type": "integer"}], "security": [{"heroCognitoToken": []}], "tags": ["data"]}}, "/v1/feedbackmessages/viewstate/{job_id}": {"parameters": [{"in": "path", "description": "The job id", "name": "job_id", "required": true, "type": "integer"}], "post": {"responses": {"200": {"description": "Success"}}, "summary": "Updates the  the feedback message view state of the owner", "operationId": "post_feedback_message_view_state", "tags": ["jobs"]}}, "/v1/feedbackmessages/{job_id}": {"parameters": [{"in": "path", "description": "The job identifier (id)", "name": "job_id", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/FeedbackMessageView"}}}, "summary": "Reads feedback messages for a jobId", "operationId": "get_feedback_messages", "parameters": [{"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "page", "in": "query", "type": "integer"}, {"name": "pageSize", "in": "query", "type": "integer"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/FeedbackMessageView"}}}, "summary": "Create a feedback message between owner and worker for a job", "operationId": "create_feedback_message", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateFeedbackMessage"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/field_datasets/data/{app_uuid}/{field_id}": {"parameters": [{"in": "path", "description": "The field identifier", "name": "field_id", "required": true, "type": "string"}, {"in": "path", "description": "The application UUID", "name": "app_uuid", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Field dataset not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/FieldDataset"}}}, "summary": "Fetch a field dataset by its application UUID and field ID", "operationId": "get_field_dataset", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["field_datasets"]}, "put": {"responses": {"404": {"description": "Field dataset not found"}}, "summary": "Append to a field dataset given its application UUID and field ID", "operationId": "append_field_dataset", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/FieldDatasetInput"}}], "security": [{"apiToken": []}], "tags": ["field_datasets"]}, "post": {"responses": {"404": {"description": "Field dataset not found"}}, "summary": "Create a field dataset given its application UUID and field ID", "operationId": "create_field_dataset", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/FieldDatasetInput"}}], "security": [{"apiToken": []}], "tags": ["field_datasets"]}}, "/v1/field_datasets/data/{app_uuid}/{field_id}/download": {"parameters": [{"in": "path", "description": "The field identifier", "name": "field_id", "required": true, "type": "string"}, {"in": "path", "description": "The application UUID", "name": "app_uuid", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Field dataset not found"}}, "summary": "Download a field dataset as CSV", "operationId": "download_field_dataset", "security": [{"apiToken": []}], "tags": ["field_datasets"]}}, "/v1/field_datasets/params/{app_uuid}": {"parameters": [{"in": "path", "description": "The application UUID", "name": "app_uuid", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "App not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/FieldParamDatasets"}}}, "summary": "Fetch all field datasets by application UUID", "operationId": "get_app_field_datasets", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["field_datasets"]}}, "/v1/field_datasets/params/{app_uuid}/{field_id}": {"parameters": [{"in": "path", "description": "The field identifier", "name": "field_id", "required": true, "type": "string"}, {"in": "path", "description": "The application UUID", "name": "app_uuid", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "App not found"}}, "summary": "update field datasets by application UUID and field id", "operationId": "update_app_field_datasets", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/FieldParamDatasetsUpdateInput"}}], "security": [{"apiToken": []}], "tags": ["field_datasets"]}}, "/v1/heroes/{hero_id}": {"parameters": [{"name": "hero_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Hero"}}}, "summary": "Get hero information", "operationId": "Hero", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["heroes"]}}, "/v1/heroes/{hero_uuid}/apps/{app_uuid}/disabled": {"parameters": [{"name": "hero_uuid", "in": "path", "required": true, "type": "string"}, {"name": "app_uuid", "in": "path", "required": true, "type": "string"}], "delete": {"responses": {"204": {"description": "Remove hero disabled for app"}}, "summary": "Removes hero from disabled list of heroes per app", "operationId": "remove hero app disabled", "security": [{"apiToken": []}], "tags": ["heroes"]}, "post": {"responses": {"204": {"description": "Add hero disabled for app"}}, "summary": "Adds hero to disabled list of heroes per app", "operationId": "add hero app disabled", "security": [{"apiToken": []}], "tags": ["heroes"]}}, "/v1/heroes/{hero_uuid}/status": {"parameters": [{"name": "hero_uuid", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"204": {"description": "Hero status updated"}}, "summary": "Update hero status", "operationId": "update hero status", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateHeroStatus"}}], "security": [{"apiToken": []}], "tags": ["heroes"]}}, "/v1/inbox/verify/{app_id}": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/VerificationModel"}}}, "operationId": "Checks status of inbox verification", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["inbox"]}, "post": {"responses": {"200": {"description": "Success"}}, "operationId": "Sends verification request for inbox", "security": [{"apiToken": []}], "tags": ["inbox"]}}, "/v1/inbox/{app_id}": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/InboxModel"}}}, "operationId": "Gets inbox for specified application", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["inbox"]}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/InboxModel"}}}, "operationId": "Deletes an inbox for specified application", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["inbox"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/InboxModel"}}}, "operationId": "Creates an inbox for specified application", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["inbox"]}}, "/v1/integrations/apps/{app_id}/data/uploaded": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"200": {"description": "Success"}}, "operationId": "Updates the database after an object has been uploaded to the storage", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DataUploadModel"}}], "security": [{"apiToken": []}], "tags": ["integrations"]}}, "/v1/integrations/apps/{app_id}/submit-job": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"201": {"description": "Jobs Submitted", "schema": {"$ref": "#/definitions/JobSubmitted"}}}, "operationId": "Updates the database after a job has been submitted to the storage", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SubmitJobModel"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["integrations"]}}, "/v1/job-big-payload/{job_id}": {"parameters": [{"name": "job_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/JobBigPayloadResponse"}}}, "summary": "Retrieve job with big payload", "operationId": "get_job_big_payload", "parameters": [{"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/JobBigPayloadResponse"}}}, "summary": "Resolve job with big payload", "operationId": "post_job_big_payload", "parameters": [{"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/job-big-payload/{parent_job_id}/child/{sequence}": {"parameters": [{"name": "parent_job_id", "in": "path", "required": true, "type": "string"}, {"name": "sequence", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/JobBigPayloadResponse"}}}, "summary": "Retrieve child job with big payload by sequence", "operationId": "get_child_job_big_payload", "parameters": [{"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/labeler-feedback": {"post": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/FeedbackMessageView"}}}}, "operationId": "create_labeler_feedback", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateLabelerFeedback"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/with-message/{job_id}": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobWithFeedbackMessage"}}}, "summary": "Fetch a job given its identifier", "operationId": "fetch_job_with_message", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Job"}}}, "summary": "Fetch a job given its identifier", "operationId": "fetch_job", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}, "delete": {"responses": {"404": {"description": "Job not found"}, "202": {"description": "Success", "schema": {"$ref": "#/definitions/JobCanceledDeleted"}}, "204": {"description": "Job deleted"}}, "summary": "Delete a job given its identifier", "operationId": "delete_job", "parameters": [{"name": "deleteSubjectData", "in": "query", "type": "boolean", "default": false}, {"name": "deleteResponseData", "in": "query", "type": "boolean", "default": false}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/audit": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobsAuditList"}}}, "summary": "Get paginated list of job audit", "operationId": "job_audit", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string", "default": "id"}, {"name": "orderBy", "in": "query", "type": "string", "default": "desc"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/cancel": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobCanceledDeleted"}}, "202": {"description": "Success", "schema": {"$ref": "#/definitions/JobCanceledDeleted"}}}, "summary": "Cancel the given job resource", "operationId": "cancel_job", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/complete": {"parameters": [{"name": "job_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Job"}}}, "summary": "Complete parked/pending job", "operationId": "complete_pending_job", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/JobComplete"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/current_labelers": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobLabelers"}}}, "summary": "Get current job labelers", "operationId": "get_job_labelers", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/diff": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobDiff"}}}, "summary": "Get diff of job versions", "description": "Set Accept header as text/markdown to directly return markdown response", "operationId": "job_diff", "parameters": [{"name": "original", "in": "query", "type": "string", "default": "1"}, {"name": "revision", "in": "query", "type": "string", "default": "latest"}, {"name": "useMD", "in": "query", "type": "boolean", "default": false}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/history": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobsHistoryList"}}}, "summary": "Get paginated list of job history", "operationId": "job_history", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string", "default": "version"}, {"name": "orderBy", "in": "query", "type": "string", "default": "desc"}, {"name": "latestVersion", "in": "query", "type": "boolean", "default": true}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/history/{version}/response": {"parameters": [{"in": "path", "description": "The job history version", "name": "version", "required": true, "type": "integer"}, {"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobResponse"}}}, "summary": "Get job history response", "operationId": "job_history_response", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/info": {"parameters": [{"in": "path", "description": "The job identifier (id or uuid)", "name": "job_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobInfo"}}}, "summary": "Fetch the job info for a job given its identifier", "operationId": "fetch_job_info", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/label": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Job"}}}, "summary": "Label collaborator job", "operationId": "label_job", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/JobLabel"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/post-process": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "patch": {"responses": {"404": {"description": "Job not found"}}, "operationId": "job_postprocess", "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/relabel": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "Job not found"}, "201": {"description": "Success", "schema": {"$ref": "#/definitions/JobSubmittedRelabel"}}}, "summary": "Relabel the given job resource", "operationId": "relabel_job", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/response": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobResponse"}}}, "summary": "Get response (output) for the given job resource", "operationId": "job_response", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/review": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "patch": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobReviewOutput"}}}, "operationId": "job_review", "parameters": [{"name": "createsHistory", "in": "query", "type": "boolean", "default": true}, {"name": "postProcess", "in": "query", "type": "boolean", "default": true}, {"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/JobReview"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/start": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "string"}], "post": {"responses": {"404": {"description": "Job not found"}, "204": {"description": "Started job"}}, "summary": "Start the given job", "operationId": "start_job", "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/tags": {"parameters": [{"in": "path", "description": "Job id", "name": "job_id", "required": true, "type": "string"}], "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Job"}}}, "summary": "Add tags to job by job id", "operationId": "add_tags_to_job", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/JobTags"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Job"}}}, "summary": "Remove tags from job by job id", "operationId": "delete_tags_from_job", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/JobTags"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/tasks": {"parameters": [{"name": "job_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/JobTasksInfoList"}}}, "summary": "Get tasks of job", "operationId": "get_job_tasks_info", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "stateIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "name", "in": "query", "type": "string"}, {"name": "createdStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "createdEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedStartDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "completedEndDate", "in": "query", "type": "string", "format": "date-time"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["task-info"]}}, "/v1/jobs/{job_id}/tasks/{task_id}": {"parameters": [{"name": "job_id", "in": "path", "required": true, "type": "string"}, {"name": "task_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/JobTaskInfo"}}}, "summary": "Get single task of job", "operationId": "get_job_task_info", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["task-info"]}}, "/v1/jobs/{job_id}/tasks/{task_id}/review": {"parameters": [{"name": "job_id", "in": "path", "required": true, "type": "string"}, {"name": "task_id", "in": "path", "required": true, "type": "integer"}], "patch": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/JobTaskInfo"}}}, "summary": "Review task of job", "operationId": "review_task_of_job", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TaskReview"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["task-info"]}}, "/v1/jobs/{job_id}/viewing_users": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "integer"}], "get": {"responses": {"404": {"description": "Job not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobViewingUsers"}}}, "summary": "Get list of users viewing the job now", "operationId": "fetch_viewing_users", "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/jobs/{job_id}/viewing_users/me": {"parameters": [{"in": "path", "description": "The job identifier", "name": "job_id", "required": true, "type": "integer"}], "delete": {"responses": {"204": {"description": "Successfully modified viewing users"}, "404": {"description": "Job not found"}}, "summary": "Delete the current user from the list of viewing users", "operationId": "delete_viewing_user", "security": [{"apiToken": []}], "tags": ["jobs"]}, "post": {"responses": {"204": {"description": "Successfully modified viewing users"}, "404": {"description": "Job not found"}}, "summary": "Add the current user to the list of viewing users", "operationId": "add_viewing_user", "security": [{"apiToken": []}], "tags": ["jobs"]}}, "/v1/metric_constraint": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/MetricConstraintReturn"}}}, "operationId": "get metrics for constraints with optional name filter", "parameters": [{"name": "name", "in": "query", "type": "string"}, {"name": "page", "in": "query", "type": "integer", "description": "Page number"}, {"name": "size", "in": "query", "type": "integer", "description": "Size of page"}, {"name": "sortBy", "in": "query", "type": "string", "description": "Sort parameter"}, {"name": "orderBy", "in": "query", "type": "string", "description": "Order parameter (asc, desc)"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["metrics"]}}, "/v1/onboarding/code": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OnboardingCode"}}}, "summary": "Get a code for onboarding", "operationId": "get_onboarding_code", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["onboarding codes"]}}, "/v1/onboarding/code/{code}": {"parameters": [{"name": "code", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OnboardingUUID"}}, "404": {"description": "UUID not found"}}, "summary": "Get job uuid  for onboarding", "operationId": "get_job_uuid_from_onboarding_code", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["onboarding codes"]}}, "/v1/operations/{app_id}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OperationsList"}}}, "summary": "Shows a list of all operations, within app app_id", "operationId": "list_operations", "parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string", "description": "Application id"}, {"name": "page", "in": "query", "type": "integer", "default": 0, "description": "Page number"}, {"name": "size", "in": "query", "type": "integer", "default": 10, "description": "Size of page"}, {"name": "sortBy", "in": "query", "type": "string", "default": "id", "description": "Sort parameter"}, {"name": "orderBy", "in": "query", "type": "string", "default": "asc", "description": "Order parameter (asc, desc)"}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: SCHEDULED, IN_PROGRESS, COMPLETED, FAILED, ARCHIVED"}, {"name": "typeIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: APP_UPDATED, CANCEL, DELETE, DOWNLOAD, START, RELABEL, POST_PROCESS"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["operations"]}}, "/v1/operations/{app_id}/{operation_id}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Operation"}}}, "summary": "Get operation within app app_id by operation id", "operationId": "get_operation", "parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string", "description": "Application id"}, {"name": "operation_id", "in": "path", "required": true, "type": "integer", "description": "Operation id"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["operations"]}, "delete": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Operation"}}}, "summary": "Archive operation within app app_id by operation id", "operationId": "delete_operation", "parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string", "description": "Application id"}, {"name": "operation_id", "in": "path", "required": true, "type": "integer", "description": "Operation id"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["operations"]}}, "/v1/operations/{app_id}/{operation_id}/download-url": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DownloadsJobsUrl"}}}, "summary": "Generates download jobs url by app id and operation id", "operationId": "download_operation", "parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string", "description": "Application id"}, {"name": "operation_id", "in": "path", "required": true, "type": "integer", "description": "Operation id"}, {"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["operations"]}}, "/v1/operations/{app_id}/{operation_id}/retry": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Operation"}}}, "summary": "Retry failed operation by app id and operation id", "operationId": "retry_operation", "parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string", "description": "Application id"}, {"name": "operation_id", "in": "path", "required": true, "type": "integer", "description": "Operation id"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["operations"]}}, "/v1/organizations": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OrganizationList"}}}, "summary": "Shows a list of all organizations that the user belongs to", "operationId": "list_organizations", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["organizations"]}}, "/v1/organizations/invitations": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OrganizationMember"}}}, "summary": "Get organization invitations", "operationId": "get_organization_invitations", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["organizations"]}}, "/v1/organizations/{username}/apps": {"parameters": [{"name": "username", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/AppsReturn"}}}, "summary": "Shows a list of all apps that belongs to organization", "operationId": "list_organization_apps", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "searchTerm", "in": "query", "type": "string"}, {"name": "workflowName", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["organizations"]}}, "/v1/organizations/{username}/invite": {"parameters": [{"name": "username", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OrganizationMember"}}}, "summary": "Creates an invitation to organization", "operationId": "create_organization_invitation", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateInvitationRequest"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["organizations"]}}, "/v1/organizations/{username}/invite/{member_id}/accept": {"parameters": [{"name": "username", "in": "path", "required": true, "type": "string"}, {"name": "member_id", "in": "path", "required": true, "type": "integer"}], "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OrganizationMember"}}}, "summary": "Accept an invitation to organization", "operationId": "accept_organization_invitation", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["organizations"]}}, "/v1/organizations/{username}/invite/{member_id}/user-exists": {"parameters": [{"name": "username", "in": "path", "required": true, "type": "string"}, {"name": "member_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UserExistsModel"}}}, "summary": "Checks organization invite user exists", "operationId": "get_organization_invite_user_exists", "parameters": [{"name": "verification_code", "in": "query", "type": "string", "required": true}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["organizations"]}}, "/v1/organizations/{username}/members": {"parameters": [{"name": "username", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OrganizationList"}}}, "summary": "Shows a list of all members that belongs to organization", "operationId": "list_organization_members", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["organizations"]}}, "/v1/organizations/{username}/members/{member_id}": {"parameters": [{"name": "username", "in": "path", "required": true, "type": "string"}, {"name": "member_id", "in": "path", "required": true, "type": "integer"}], "patch": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/OrganizationMember"}}}, "summary": "Updates a members that belongs to organization", "operationId": "update_organization_member", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateOrganizationMemberRequest"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["organizations"]}, "delete": {"responses": {"204": {"description": "Member deleted"}}, "summary": "Deletes a members that belongs to organization", "operationId": "delete_organization_member", "security": [{"apiToken": []}], "tags": ["organizations"]}}, "/v1/schema": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/SchemaOutput"}}}, "summary": "Generate Schema", "operationId": "generate_schema", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SchemaInput"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["schema"]}}, "/v1/tags": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TagsReturn"}}}, "summary": "Get tags [MOCK]", "operationId": "list_tags", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "createdDate", "in": "query", "type": "string", "format": "date"}, {"name": "templates", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "collaborators", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "datasets", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "apis", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "jobs", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["tags"]}, "post": {"responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/Tag"}}}, "summary": "Create tag [MOCK]", "operationId": "create_tag", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagInput"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["tags"]}}, "/v1/tags/{tag_id}": {"parameters": [{"in": "path", "description": "The tag identifier", "name": "tag_id", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Tag not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Tag"}}}, "summary": "Fetch a tag by its id [MOCK]", "operationId": "get_tag", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["tags"]}, "put": {"responses": {"404": {"description": "Tag not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Tag"}}}, "summary": "Update a tag given its identifier [MOCK]", "operationId": "update_tag", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagInput"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["tags"]}, "delete": {"responses": {"404": {"description": "Tag not found"}, "204": {"description": "App deleted"}}, "summary": "Delete a tag given its identifier [MOCK]", "operationId": "delete_tag", "tags": ["tags"]}}, "/v1/task-big-payload/by-job/{job_id}/{sequence}/resolved": {"parameters": [{"name": "job_id", "in": "path", "required": true, "type": "string"}, {"name": "sequence", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TaskBigPayloadResponse"}}}, "summary": "Retrieve resolved task with big payload by job and sequence", "operationId": "get_resolved_task_big_payload_by_job", "parameters": [{"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["tasks"]}}, "/v1/task-big-payload/{worker_id}/{task_id}": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "string"}, {"name": "task_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TaskBigPayloadResponse"}}}, "operationId": "get_task_big_payload", "parameters": [{"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "action", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"heroCognitoToken": []}], "tags": ["tasks"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TaskBigPayloadResponse"}}}, "operationId": "update_task_big_payload", "parameters": [{"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "action", "in": "query", "type": "string", "description": "Available values : RESOLVE, STORE"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"heroCognitoToken": []}], "tags": ["tasks"]}}, "/v1/task-operations/{app_id}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TaskOperationsList"}}}, "summary": "Shows a list of all task operations, within app app_id", "operationId": "list_task_operations", "parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string", "description": "Application id"}, {"name": "page", "in": "query", "type": "integer", "default": 0, "description": "Page number"}, {"name": "size", "in": "query", "type": "integer", "default": 10, "description": "Size of page"}, {"name": "sortBy", "in": "query", "type": "string", "default": "id", "description": "Sort parameter"}, {"name": "orderBy", "in": "query", "type": "string", "default": "asc", "description": "Order parameter (asc, desc)"}, {"name": "statusIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: SCHEDULED, IN_PROGRESS, FAILED, COMPLETED"}, {"name": "typeIn", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi", "description": "Available values: DOWNLOAD"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["task-operations"]}}, "/v1/task-operations/{app_id}/{operation_id}": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TaskOperation"}}}, "summary": "Get task operation by app app_id by operation id", "operationId": "get_task_operation", "parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string", "description": "Application id"}, {"name": "operation_id", "in": "path", "required": true, "type": "integer", "description": "Operation id"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["task-operations"]}}, "/v1/task-operations/{app_id}/{operation_id}/download-url": {"post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/DownloadsTasksUrl"}}}, "summary": "Generates download jobs url by app id and operation id", "operationId": "download_task_operation", "parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string", "description": "Application id"}, {"name": "operation_id", "in": "path", "required": true, "type": "integer", "description": "Operation id"}, {"name": "secondsTtl", "in": "query", "type": "integer"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["task-operations"]}}, "/v1/task-templates/{task_template_name}": {"parameters": [{"in": "path", "description": "The task template identifier", "name": "task_template_name", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Task Template not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TaskTemplate"}}}, "summary": "Fetch a given resource", "operationId": "get_task_template", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["task templates"]}, "put": {"responses": {"404": {"description": "Task Template not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TaskTemplate"}}}, "summary": "Create or update a template given its full qualified name", "description": "If the template already exists and it is owned by\n somebody else then if will throw a 409", "operationId": "update_task_template", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TaskTemplate"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["task templates"]}}, "/v1/taskqueue/feedbackoptions/{worker_id}/{task_id}": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "string"}, {"name": "task_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "operationId": "get_feedback_options", "security": [{"heroCognitoToken": []}], "tags": ["tasks"]}}, "/v1/taskqueue/filter/{worker_id}": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "operationId": "get_task_filter", "parameters": [{"name": "size", "in": "query", "type": "integer", "required": true}, {"name": "id", "in": "query", "type": "integer"}, {"name": "state", "in": "query", "type": "string", "required": true, "description": "Available values : SCHEDULED, IN_PROGRESS, PENDING, REJECTED, EXPIRED, COMPLETED, CANCELED"}], "security": [{"heroCognitoToken": []}], "tags": ["tasks"]}}, "/v1/taskqueue/history/{worker_id}": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "operationId": "get_task_history", "parameters": [{"name": "size", "in": "query", "type": "integer", "required": true}, {"name": "id", "in": "query", "type": "integer"}], "security": [{"heroCognitoToken": []}], "tags": ["tasks"]}}, "/v1/taskqueue/message/{worker_id}/training/{training_id}": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TrainingExampleModel"}}}, "operationId": "get_training_example", "parameters": [{"name": "sequence", "in": "query", "type": "integer"}, {"name": "exampleId", "in": "query", "type": "integer"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"heroCognitoToken": []}], "tags": ["tasks"]}}, "/v1/taskqueue/pendingmessage/{worker_id}": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "operationId": "get_pending_taks", "security": [{"heroCognitoToken": []}], "tags": ["tasks"]}}, "/v1/taskqueue/pendingmessage/{worker_id}/training/{trainingId}": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "string"}, {"name": "trainingId", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success"}}, "operationId": "get_pending_training_tasks", "parameters": [{"name": "sequence", "in": "query", "type": "integer"}], "security": [{"heroCognitoToken": []}], "tags": ["tasks"]}}, "/v1/taskqueue/pendingmessage/{worker_id}/{conversation}": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "string"}, {"name": "conversation", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success"}}, "operationId": "get_pending_taks_with_conversation", "security": [{"heroCognitoToken": []}], "tags": ["tasks"]}}, "/v1/taskqueue/tasks/{job_id}": {"parameters": [{"name": "job_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "operationId": "get_task_by_job", "parameters": [{"name": "active", "in": "query", "type": "boolean", "required": true}, {"name": "worker", "in": "query", "type": "string"}], "security": [{"heroCognitoToken": []}], "tags": ["tasks"]}}, "/v1/taskqueue/tasks/{worker_id}/{task_id}": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "string"}, {"name": "task_id", "in": "path", "required": true, "type": "integer"}], "patch": {"responses": {"200": {"description": "Success"}}, "operationId": "update_task", "parameters": [{"name": "action", "in": "query", "type": "string", "description": "Available values : RESOLVE, REJECT, DETACH, READ, STORE"}, {"name": "hitAssignmentId", "in": "query", "type": "string"}, {"name": "hitId", "in": "query", "type": "string"}, {"name": "hitWorkerId", "in": "query", "type": "string"}, {"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TaskUpdate"}}], "security": [{"heroCognitoToken": []}], "tags": ["tasks"]}}, "/v1/templates": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/TemplatesList"}}}, "summary": "List all templates (Tags param is mock)", "operationId": "list_templates", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "only_owned_or_group", "in": "query", "type": "boolean"}, {"name": "inputTypes", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "outputTypes", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app templates"]}}, "/v1/templates/search": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/ElasticSearchTemplatesList"}}, "400": {"description": "Query must be shorter than 128 characters"}}, "operationId": "search_templates", "parameters": [{"in": "query", "description": "Page number, from 0 to N", "name": "page", "type": "integer"}, {"name": "query", "in": "query", "type": "string", "default": ""}, {"name": "size", "in": "query", "type": "integer"}, {"name": "input_types", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "output_types", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "tags", "in": "query", "type": "array", "items": {"type": "string"}, "collectionFormat": "multi"}, {"name": "type", "in": "query", "type": "string"}, {"name": "results", "in": "query", "type": "boolean", "default": false}, {"name": "suggestions", "in": "query", "type": "boolean", "default": false}, {"name": "sortByFreeTrial", "in": "query", "type": "boolean", "default": false}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app templates"]}}, "/v1/templates/tags": {"get": {"responses": {"200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ElasticTagTemplate"}}}}, "operationId": "tag_templates", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "tags": ["app templates"]}}, "/v1/templates/{template_name}": {"parameters": [{"in": "path", "description": "The template identifier", "name": "template_name", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Template not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Template"}}}, "summary": "Fetch a given resource", "operationId": "get_template", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app templates"]}, "put": {"responses": {"404": {"description": "Template not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/Template"}}}, "summary": "Create or update a template given its full qualified name", "description": "If the template already exists and it is owned by\n somebody else then if will throw a 409", "operationId": "update_template", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/Template"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app templates"]}}, "/v1/templates/{template_name}/availability": {"parameters": [{"in": "path", "description": "The template identifier", "name": "template_name", "required": true, "type": "string"}], "get": {"responses": {"204": {"description": "Data program is available"}, "404": {"description": "Template not found"}}, "summary": "Returns 204 if template is available", "operationId": "check_template_availability", "security": [{"apiToken": []}], "tags": ["app templates"]}}, "/v1/templates/{template_name}/sample-app": {"parameters": [{"in": "path", "description": "The template identifier", "name": "template_name", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Template or app not found"}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SampleApp"}}}, "summary": "Fetch the requested sample app with its input data", "operationId": "get_sample_app", "parameters": [{"name": "sampleAppIdentifier", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["app templates"]}}, "/v1/test_url/{app_id}/{uuid}/jobs": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}, {"name": "uuid", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Job confirmation not found"}}, "summary": "Get a job for onboarding", "operationId": "test_get_job_confirmation", "tags": ["test urls"]}, "post": {"responses": {"200": {"description": "Successfully submitted job"}}, "summary": "Create a job for onboarding", "operationId": "test_post_job", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TestUrlInput"}}], "tags": ["test urls"]}}, "/v1/users": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/User"}}}, "summary": "Fetch a given resource", "operationId": "get_user", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"authToken": []}], "tags": ["authentication"]}, "put": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UserUpdate"}}}, "summary": "Update a user given its identifier", "operationId": "update_user", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserUpdateInput"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"authToken": []}], "tags": ["authentication"]}, "post": {"responses": {"201": {"description": "Success", "schema": {"$ref": "#/definitions/User"}}, "400": {"description": "Invalid Parameters"}}, "summary": "Create a new user", "operationId": "create_user", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserInput"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"authToken": []}], "tags": ["authentication"]}}, "/v1/users/apiKeys": {"get": {"responses": {"200": {"description": "Success"}}, "summary": "List all API keys", "operationId": "list_api_keys", "security": [{"authToken": []}], "tags": ["authentication"]}}, "/v1/users/apiKeys/create": {"parameters": [{"in": "query", "description": "type of API key. Should be one of [\"live\", \"test\"]", "name": "type", "type": "string"}], "get": {"responses": {"200": {"description": "Success"}}, "summary": "Create a new API key", "operationId": "create_api_keys", "security": [{"authToken": []}], "tags": ["authentication"]}}, "/v1/users/apiKeys/{api_key_value}/delete": {"parameters": [{"in": "path", "description": "The API key value", "name": "api_key_value", "required": true, "type": "string"}], "get": {"responses": {"404": {"description": "Token not found"}, "204": {"description": "API key deleted"}}, "summary": "Delete a API key", "operationId": "delete_api_keys", "security": [{"authToken": []}], "tags": ["authentication"]}}, "/v1/users/app/{app_id}/status": {"parameters": [{"name": "app_id", "in": "path", "required": true, "type": "string"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UserStatusApp"}}}, "summary": "Get user status", "operationId": "get_user_status_by_app", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["authentication"]}}, "/v1/users/awsKeys": {"get": {"responses": {"200": {"description": "Success"}}, "summary": "Get aws keys", "operationId": "retrieve_aws_keys", "security": [{"idToken": []}], "tags": ["authentication"]}}, "/v1/users/onboarded": {"post": {"responses": {"200": {"description": "Success"}}, "summary": "Set user as onboarded", "operationId": "post_user_onboarded", "security": [{"apiToken": []}], "tags": ["authentication"]}}, "/v1/users/status": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UserStatus"}}}, "summary": "Get user status", "operationId": "get_user_status", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["authentication"]}}, "/v1/worker-groups": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerGroupList"}}}, "summary": "Shows a list of all worker groups that the user or org owns", "operationId": "list_worker_groups", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "org", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["worker groups"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerGroup"}}}, "summary": "Creates a worker group", "operationId": "create_worker_group", "parameters": [{"name": "org", "in": "query", "type": "string"}, {"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateWorkerGroup"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["worker groups"]}}, "/v1/worker-groups/{worker_group_id}": {"parameters": [{"name": "worker_group_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerGroup"}}}, "summary": "Get worker group", "operationId": "get_worker_group", "parameters": [{"name": "org", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["worker groups"]}, "patch": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerGroup"}}}, "summary": "Updates a worker group", "operationId": "update_worker_group", "parameters": [{"name": "org", "in": "query", "type": "string"}, {"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateWorkerGroup"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["worker groups"]}, "delete": {"responses": {"204": {"description": "Worker group deleted"}}, "summary": "Delete worker group", "operationId": "delete_worker_group", "parameters": [{"name": "org", "in": "query", "type": "string"}], "security": [{"apiToken": []}], "tags": ["worker groups"]}}, "/v1/workers": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerList"}}}, "summary": "Shows a list of all workers that the user or org owns", "operationId": "list_workers", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "org", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["workers"]}, "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Worker"}}}, "summary": "Creates a worker", "operationId": "create_worker", "parameters": [{"name": "org", "in": "query", "type": "string"}, {"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateWorker"}}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["workers"]}}, "/v1/workers/invitations": {"get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Worker"}}}, "summary": "Get worker invitations", "operationId": "get_worker_invitations", "parameters": [{"name": "page", "in": "query", "type": "integer"}, {"name": "size", "in": "query", "type": "integer"}, {"name": "sortBy", "in": "query", "type": "string"}, {"name": "orderBy", "in": "query", "type": "string"}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["workers"]}}, "/v1/workers/{worker_id}": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "integer"}], "delete": {"responses": {"204": {"description": "Worker deleted"}}, "summary": "Delete worker", "operationId": "delete_worker", "parameters": [{"name": "org", "in": "query", "type": "string"}], "security": [{"apiToken": []}], "tags": ["workers"]}}, "/v1/workers/{worker_id}/accept": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "integer"}], "post": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkerList"}}}, "summary": "Accept worker invitation", "operationId": "accept_worker_invitation", "parameters": [{"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["workers"]}}, "/v1/workers/{worker_id}/user-exists": {"parameters": [{"name": "worker_id", "in": "path", "required": true, "type": "integer"}], "get": {"responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/UserExistsModel"}}}, "summary": "Checks worker invite user exists", "operationId": "get_worker_invite_user_exists", "parameters": [{"name": "verification_code", "in": "query", "type": "string", "required": true}, {"name": "X-Fields", "in": "header", "type": "string", "format": "mask", "description": "An optional fields mask"}], "security": [{"apiToken": []}], "tags": ["workers"]}}}, "info": {"title": "super.AI API", "version": "2.0.177.120", "description": "super.AI App Store API"}, "produces": ["application/json", "text/markdown"], "consumes": ["application/json"], "securityDefinitions": {"authToken": {"type": "apiKey", "in": "header", "name": "AUTH-TOKEN"}, "idToken": {"type": "apiKey", "in": "header", "name": "ID-TOKEN"}, "apiToken": {"type": "apiKey", "in": "header", "name": "API-KEY"}, "heroCognitoToken": {"type": "apiKey", "in": "header", "name": "Authorization"}}, "tags": [{"name": "app instances", "description": "AI app related CRUD"}, {"name": "app templates", "description": "App templates related CRUD"}, {"name": "authentication", "description": "Authenticate user, and validate tokens"}, {"name": "baseline data", "description": "Baseline data CRUD"}, {"name": "billing", "description": "Billing CRUD"}, {"name": "collaborator", "description": "Collaborator CRUD"}, {"name": "collaborator metrics", "description": "Collaborator Metrtics CRUD"}, {"name": "data", "description": "Data CRUD"}, {"name": "jobs", "description": "Jobs related CRUD"}, {"name": "metrics", "description": "Metrics and Measurer CRUD"}, {"name": "tags", "description": "Tags related CRUD"}, {"name": "test urls", "description": "Onboarding test urls"}, {"name": "onboarding codes", "description": "Onboarding code generator"}, {"name": "tasks", "description": "Tasks api for Crowd Heroes"}, {"name": "collaborator tasks", "description": "Collaborator Tasks api for Labelers"}, {"name": "contact", "description": "Contact details"}, {"name": "heroes", "description": "Api for heroes management"}, {"name": "organizations", "description": "Organizations related CRUD"}, {"name": "workers", "description": "Workers related CRUD"}, {"name": "worker groups", "description": "Worker groups related CRUD"}, {"name": "operations", "description": "Operations CRUD"}, {"name": "authentication", "description": "Provide backoffice service"}, {"name": "task-info", "description": "Task information CRUD"}, {"name": "task-operations", "description": "Task Operations retrieval"}, {"name": "task templates", "description": "Task templates related CRUD"}, {"name": "integrations", "description": "Customer integrations"}, {"name": "schema", "description": "schema generation and validation"}, {"name": "inbox", "description": "Application Inbox"}, {"name": "field_datasets", "description": "FieldDatasets related CRUD"}], "definitions": {"AppInput": {"properties": {"appName": {"type": "string", "description": "Name of the app"}, "templateName": {"type": "string", "description": "The class of the app instance"}, "projectName": {"type": "string"}, "metadata": {"type": "object"}, "appParams": {"type": "object"}, "appMetrics": {"type": "object"}, "canoticCrowd": {"type": "boolean"}, "status": {"type": "string"}, "constraints": {"type": "object"}, "dpWorkflows": {"type": "array", "items": {"type": "string"}}, "selectedWorkflow": {"type": "string"}, "cancelAndRelabelJobsInState": {"type": "array", "default": ["UNPROCESSED"], "items": {"type": "string", "example": "UNPROCESSED", "enum": ["UNPROCESSED", "IN_PROGRESS", "COMPLETED"]}}, "visibility": {"type": "string", "example": "PRIVATE", "enum": ["PRIVATE", "PUBLIC"]}, "superTasks": {"type": "array", "items": {"$ref": "#/definitions/SuperTask"}}, "settings": {"$ref": "#/definitions/AppSettings"}}, "type": "object"}, "SuperTask": {"properties": {"parameters": {"type": "object"}, "workers": {"type": "object"}, "superTaskWorkflow": {"type": "string"}, "parametersSchema": {"type": "object"}, "workersSchema": {"type": "object"}}, "type": "object"}, "AppSettings": {"properties": {"postProcessing": {"type": "boolean"}, "downloadSettings": {"$ref": "#/definitions/DownloadAppSettings"}, "ttlSettings": {"$ref": "#/definitions/AppTTLSettings"}, "inboxSettings": {"$ref": "#/definitions/InboxAppSettings"}, "reviewSettings": {"$ref": "#/definitions/AppReviewSettings"}, "webhookSettings": {"$ref": "#/definitions/WebhookSettings"}, "allowProcessRepairedPDFs": {"type": "boolean"}}, "type": "object"}, "DownloadAppSettings": {"properties": {"customFileNameKeys": {"type": "array", "items": {"type": "string"}}, "expandOutputColumns": {"type": "boolean"}, "includeMessages": {"type": "boolean"}, "includeAnnotations": {"type": "boolean"}, "flattenTables": {"type": "boolean"}, "excludeHeaderRow": {"type": "boolean"}, "fieldDelimiter": {"type": "string"}, "quoteValues": {"type": "boolean"}, "sendEmail": {"type": "boolean"}, "saveSettings": {"type": "boolean"}}, "type": "object"}, "AppTTLSettings": {"properties": {"onCompleted": {"$ref": "#/definitions/TTLSettings"}}, "type": "object"}, "TTLSettings": {"properties": {"enabled": {"type": "boolean"}, "ttlInSeconds": {"type": "integer"}}, "type": "object"}, "InboxAppSettings": {"properties": {"allowedEmails": {"type": "array", "items": {"type": "string"}}, "callbackUrl": {"type": "string"}, "emailExtractionMode": {"type": "string", "default": "ONLY_ATTACHMENTS", "example": "ONLY_ATTACHMENTS", "enum": ["ONLY_ATTACHMENTS", "ONLY_BODY", "BODY_AND_ATTACHMENTS"]}, "emailMarkJobWithMetadataMode": {"type": "string", "default": "NO_METADATA", "example": "NO_METADATA", "enum": ["NO_METADATA", "RANDOM_UUID", "EMAIL_SENDER_EMAIL_ID"]}}, "type": "object"}, "AppReviewSettings": {"properties": {"autoAccept": {"$ref": "#/definitions/ReviewAutoAccept"}, "acceptViewed": {"type": "boolean"}, "reviewBlank": {"type": "boolean"}, "reviewFailed": {"type": "boolean"}, "randomPercentage": {"type": "integer", "minimum": 0, "maximum": 100}, "tags": {"type": "array", "items": {"type": "string"}}, "thresholds": {"type": "array", "minItems": 2, "maxItems": 2, "items": {"type": "number", "minimum": 0.0, "maximum": 1.0}}, "validateChangesAfterReview": {"type": "boolean"}}, "type": "object"}, "ReviewAutoAccept": {"properties": {"type": {"type": "string", "example": "Days", "enum": ["Days", "Weeks", "Months"]}, "value": {"type": "integer", "minimum": 0}}, "type": "object"}, "WebhookSettings": {"properties": {"callbackUrl": {"type": "string"}, "method": {"type": "string", "example": "POST", "enum": ["POST", "PATCH", "PUT"]}, "sendBatchEvents": {"type": "boolean"}}, "type": "object"}, "AppsReturn": {"properties": {"apps": {"type": "array", "items": {"$ref": "#/definitions/App"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}, "totalArchivedApps": {"type": "integer"}}, "type": "object"}, "App": {"allOf": [{"$ref": "#/definitions/AppSecondInput"}, {"properties": {"uuid": {"type": "string", "description": "The app instance unique identifier"}, "created": {"type": "string", "description": "time the app was created"}, "status": {"type": "string"}, "appParamsHistory": {"type": "object"}, "appMetricsHistory": {"type": "object"}, "job_stats": {"type": "object"}, "ownerEmail": {"type": "string"}, "enterprise": {"type": "boolean"}, "constraints": {"type": "object"}, "dpWorkflows": {"type": "array", "items": {"type": "string"}}, "selectedWorkflow": {"type": "string"}, "ownerId": {"type": "integer"}, "workerRole": {"type": "string", "example": "LABELER", "enum": ["LABELER", "REVIEWER"]}, "role": {"type": "string"}, "ownerType": {"type": "string", "example": "USER", "enum": ["USER", "ORGANIZATION"]}, "ownerUsername": {"type": "string"}, "inputSchema": {"type": "object"}, "inputUiSchema": {"type": "object"}, "outputSchema": {"type": "object"}, "outputUiSchema": {"type": "object"}, "settings": {"type": "object"}}, "type": "object"}]}, "AppSecondInput": {"properties": {"name": {"type": "string", "description": "Name of the app"}, "templateName": {"type": "string", "description": "The class of the app instance"}, "projectName": {"type": "string"}, "metadata": {"type": "object"}, "appParams": {"type": "object"}, "appMetrics": {"type": "object"}, "canoticCrowd": {"type": "boolean"}, "constraints": {"type": "object"}, "dpWorkflows": {"type": "array", "items": {"type": "string"}}, "selectedWorkflow": {"type": "string"}, "visibility": {"type": "string", "example": "PRIVATE", "enum": ["PRIVATE", "PUBLIC"]}, "superTasks": {"type": "array", "items": {"$ref": "#/definitions/SuperTask"}}}, "type": "object"}, "AppBatchIdOperationId": {"allOf": [{"$ref": "#/definitions/App"}, {"properties": {"batchId": {"type": "string"}, "operationId": {"type": "integer"}}, "type": "object"}]}, "AppSuperTasksUpdate": {"allOf": [{"$ref": "#/definitions/AppSuperTasks"}, {"properties": {"cancelAndRelabelJobsInState": {"type": "array", "default": ["UNPROCESSED"], "items": {"type": "string", "example": "UNPROCESSED", "enum": ["UNPROCESSED", "IN_PROGRESS", "COMPLETED"]}}}, "type": "object"}]}, "AppSuperTasks": {"properties": {"superTasks": {"type": "array", "items": {"$ref": "#/definitions/SuperTask"}}}, "type": "object"}, "AppOverview": {"properties": {"averageJobTimeSeconds": {"type": "number"}, "jobsCompletedPerDay": {"type": "array", "items": {"type": "integer"}}, "jobsCompleted24Hours": {"type": "integer"}, "jobsPerStatus": {"$ref": "#/definitions/AppOverviewStatus"}, "jobsReviewed": {"$ref": "#/definitions/AppOverviewCorrect"}, "totalJobs": {"type": "integer"}, "completedJobsSolelyWithAi": {"type": "integer"}, "completedJobsWithHumansAndAi": {"type": "integer"}}, "type": "object"}, "AppOverviewStatus": {"properties": {"SCHEDULED": {"type": "integer"}, "IN_PROGRESS": {"type": "integer"}, "FAILED": {"type": "integer"}, "SUSPENDED": {"type": "integer"}, "CANCELED": {"type": "integer"}, "EXPIRED": {"type": "integer"}, "COMPLETED": {"type": "integer"}, "PENDING": {"type": "integer"}}, "type": "object"}, "AppOverviewCorrect": {"properties": {"correct": {"type": "integer"}, "incorrect": {"type": "integer"}}, "type": "object"}, "AppClone": {"properties": {"appName": {"type": "string"}, "appParams": {"type": "object"}, "canoticCrowd": {"type": "boolean"}, "MakeSysAdminOwner": {"type": "boolean", "default": false}}, "type": "object"}, "AppInstanceEmail": {"properties": {"email": {"type": "string", "description": "Optional E-mail recipient for data (User e-mail will be used if not given"}}, "type": "object"}, "AppDownloadJobs": {"properties": {"operationId": {"type": "integer"}}, "type": "object"}, "AppJobResponsesLink": {"properties": {"link": {"type": "string"}}, "type": "object"}, "AppLabelingProcessModel": {"properties": {"jobs_in_queue": {"type": "integer"}, "jobs_canceled_percentage": {"type": "integer"}, "jobs_completed_percentage": {"type": "integer"}, "jobs_expired_percentage": {"type": "integer"}, "jobs_failed_percentage": {"type": "integer"}, "jobs_in_progress_percentage": {"type": "integer"}, "jobs_scheduled_percentage": {"type": "integer"}, "jobs_suspended_percentage": {"type": "integer"}}, "type": "object"}, "AppLabelingTimeLeft": {"properties": {"time_left": {"type": "integer"}}, "type": "object"}, "AppLabelingJobsTimeOverTime": {"properties": {"jobs_cost_over_time": {"type": "array", "items": {"$ref": "#/definitions/AppLabelingJobsCostOverTimePoint"}}}, "type": "object"}, "AppLabelingJobsCostOverTimePoint": {"properties": {"time": {"type": "string", "format": "date-time"}, "job_cost": {"type": "integer"}}, "type": "object"}, "AppLabelingJobsMetricsOverTime": {"properties": {"intersection over union": {"type": "array", "items": {"$ref": "#/definitions/AppLabelingJobsMetricsOverTimePoint"}}}, "type": "object"}, "AppLabelingJobsMetricsOverTimePoint": {"properties": {"x": {"type": "string", "format": "date-time"}, "y": {"type": "number"}}, "type": "object"}, "AppTagInput": {"properties": {"tag": {"type": "string"}}, "type": "object"}, "AppSelectedWorkflow": {"properties": {"uuid": {"type": "string"}, "selectedWorkflow": {"type": "string"}}, "type": "object"}, "AppDpWorkflowsMetadata": {"properties": {"dpWorkflowsMetadata": {"type": "array", "items": {"$ref": "#/definitions/DpWorkflowsMetadata"}}}, "type": "object"}, "DpWorkflowsMetadata": {"properties": {"workflow": {"type": "string"}, "metadata": {"type": "object"}}, "type": "object"}, "AppTaskMedianCompletionTime": {"properties": {"appUuid": {"type": "string"}, "tasksMedianCompletionTime": {"type": "array", "items": {"$ref": "#/definitions/TaskMedianCompletionTime"}}}, "type": "object"}, "TaskMedianCompletionTime": {"properties": {"completionTime": {"type": "number"}, "name": {"type": "string"}}, "type": "object"}, "JobFeedbackTagStats": {"properties": {"total": {"type": "integer"}, "totalUnread": {"type": "integer"}, "feedbackTagStats": {"type": "array", "items": {"$ref": "#/definitions/FeedbackTagJobStats"}}}, "type": "object"}, "FeedbackTagJobStats": {"properties": {"id": {"type": "integer"}, "parentId": {"type": "integer"}, "position": {"type": "integer"}, "tag": {"type": "string"}, "jobCount": {"type": "integer"}}, "type": "object"}, "OwnerActivity": {"properties": {"ownerId": {"type": "integer"}, "appUuid": {"type": "string"}, "lastMessageViewed": {"type": "string", "format": "date-time"}}, "type": "object"}, "Template": {"allOf": [{"$ref": "#/definitions/TemplateInput"}, {"properties": {"uuid": {"type": "string"}, "created": {"type": "string", "description": "time the template was created"}, "measurement_job_cost": {"type": "number", "description": "cost of measurement job"}, "protocol": {"type": "string"}, "visibility": {"type": "string"}, "dpWorkflows": {"type": "array", "items": {"type": "string"}}, "defaultWorkflow": {"type": "string"}, "trainingWorkflow": {"type": "string"}, "type": {"type": "string", "example": "SUPER_TASK", "enum": ["SUPER_TASK"]}, "pricing": {"type": "string"}, "workflow": {"type": "string"}, "maxActive": {"type": "integer"}, "group": {"type": "string"}, "endpoint": {"type": "string"}}, "type": "object"}]}, "TemplateInput": {"properties": {"name": {"type": "string"}, "appParamsSchema": {"type": "object"}, "appParamsUiSchema": {"type": "object"}, "appMetricsSchema": {"type": "object"}, "defaultAppParams": {"type": "object"}, "defaultAppMetrics": {"type": "object"}, "defaultConstraints": {"type": "object"}, "inputSchema": {"type": "object"}, "inputUiSchema": {"type": "object"}, "outputSchema": {"type": "object"}, "outputUiSchema": {"type": "object"}, "metadata": {"type": "object"}, "exampleData": {"type": "object"}, "endpoint": {"type": "string"}}, "type": "object"}, "TemplatesList": {"properties": {"templates": {"type": "array", "items": {"$ref": "#/definitions/Template"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "ElasticSearchTemplatesList": {"properties": {"results": {"type": "array", "items": {"$ref": "#/definitions/ElasticSearchTemplate"}}, "total_results": {"type": "integer"}, "page": {"type": "integer"}, "total_pages": {"type": "integer"}, "page_size": {"type": "integer"}, "suggestions": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "ElasticSearchTemplate": {"properties": {"name": {"type": "string"}, "id": {"type": "string"}, "cms": {"type": "boolean"}, "author": {"type": "string"}, "description": {"type": "string"}, "input_schema_types": {"type": "array", "items": {"type": "string"}}, "output_schema_types": {"type": "array", "items": {"type": "string"}}, "allow_trial": {"type": "boolean"}, "tags": {"type": "array", "items": {"type": "string"}}, "type": {"type": "string", "example": "PROJECT", "enum": ["PROJECT", "TEMPLATE"]}}, "type": "object"}, "ElasticTagTemplate": {"properties": {"tag": {"type": "string"}}, "type": "object"}, "SampleApp": {"properties": {"uuid": {"type": "string", "description": "The sample app instance unique identifier"}, "appParams": {"type": "object"}, "dataInputs": {"type": "array", "items": {"type": "object"}}}, "type": "object"}, "UserUpdateInput": {"properties": {"email": {"type": "string"}, "metadata": {"type": "object"}, "active": {"type": "boolean"}}, "type": "object"}, "UserInput": {"properties": {"email": {"type": "string"}, "metadata": {"type": "object"}, "active": {"type": "boolean"}}, "type": "object"}, "User": {"allOf": [{"$ref": "#/definitions/UserInput"}, {"properties": {"id": {"type": "string", "description": "The user instance unique identifier"}, "created": {"type": "string", "description": "time the user was created"}, "apiKey": {"type": "string"}, "company": {"type": "string"}, "sysAdmin": {"type": "boolean"}, "groups": {"type": "array", "items": {"type": "string"}}, "plan": {"type": "string", "example": "FREEMIUM", "enum": ["FREEMIUM", "FULL"]}, "username": {"type": "string"}, "backofficeAdmin": {"type": "boolean"}, "trialDays": {"type": "integer"}, "organizationMemberships": {"type": "array", "items": {"$ref": "#/definitions/OrganizationMember"}}}, "type": "object"}]}, "OrganizationMember": {"properties": {"id": {"type": "integer"}, "status": {"type": "string", "example": "INVITED", "enum": ["INVITED", "ACTIVE", "INACTIVE"]}, "role": {"type": "string", "example": "MEMBER", "enum": ["MEMBER", "OWNER"]}, "invited": {"type": "string", "format": "date-time"}, "accepted": {"type": "string", "format": "date-time"}, "created": {"type": "string", "format": "date-time"}, "orgId": {"type": "integer"}, "orgUsername": {"type": "string"}, "userId": {"type": "integer"}, "userEmail": {"type": "string"}}, "type": "object"}, "UserUpdate": {"allOf": [{"$ref": "#/definitions/UserInput"}, {"properties": {"id": {"type": "string", "description": "The user instance unique identifier"}, "email": {"type": "string"}, "created": {"type": "string", "description": "time the user was created"}, "apiKey": {"type": "string"}, "company": {"type": "string"}}, "type": "object"}]}, "UserStatus": {"properties": {"activePaymentMethodCount": {"type": "integer"}, "completedJobCount": {"type": "integer"}, "onboardingJobCount": {"type": "integer"}, "scheduledJobCount": {"type": "integer"}, "onboarded": {"type": "boolean"}}, "type": "object"}, "UserStatusApp": {"properties": {"activePaymentMethodCount": {"type": "integer"}, "allowToSubmitJob": {"type": "boolean"}, "calibratedJobCountByApp": {"type": "integer"}, "mode": {"type": "string", "example": "ONBOARDING", "enum": ["ONBOARDING", "FREEMIUM", "NORMAL", "SUSPENDED"]}, "onboardingJobCount": {"type": "integer"}, "jobsUpdatedTime": {"type": "string", "format": "date-time"}, "neededCalibratedJobs": {"type": "integer"}, "remainingCalibratedJobs": {"type": "integer"}, "metricsReady": {"type": "boolean"}, "pausedJobCount": {"type": "integer"}}, "type": "object"}, "BaselineDataInput": {"properties": {"input": {"type": "object"}, "label": {"type": "object"}, "tag": {"type": "string"}, "metadata": {"type": "object"}}, "type": "object"}, "InvoicesList": {"properties": {"invoices": {"type": "array", "items": {"$ref": "#/definitions/Invoice"}}, "total": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "Invoice": {"properties": {"id": {"type": "integer"}, "ownerId": {"type": "integer"}, "amount": {"type": "number"}, "periodStart": {"type": "string", "format": "date-time"}, "periodEnd": {"type": "string", "format": "date-time"}, "status": {"type": "string"}, "invoiceItems": {"type": "array", "items": {"$ref": "#/definitions/InvoiceItem"}}, "created": {"type": "string", "format": "date-time"}, "updated": {"type": "string", "format": "date-time"}}, "type": "object"}, "InvoiceItem": {"properties": {"id": {"type": "integer"}, "jobId": {"type": "integer"}, "status": {"type": "string"}, "jobCreated": {"type": "string", "format": "date-time"}, "created": {"type": "string", "format": "date-time"}}, "type": "object"}, "PaymentMethodInput": {"properties": {"name": {"type": "string"}, "provider": {"type": "string"}, "token": {"type": "string"}, "priority": {"type": "integer"}, "address": {"$ref": "#/definitions/Address"}}, "type": "object"}, "Address": {"properties": {"name": {"type": "string"}, "line1": {"type": "string"}, "line2": {"type": "string"}, "city": {"type": "string"}, "state": {"type": "string"}, "country": {"type": "string"}, "postalCode": {"type": "string"}}, "type": "object"}, "PaymentMethods": {"properties": {"paymentMethods": {"type": "array", "items": {"$ref": "#/definitions/PaymentMethod"}}, "total": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "PaymentMethod": {"allOf": [{"$ref": "#/definitions/PaymentMethodInput"}, {"properties": {"id": {"type": "integer"}, "ownerId": {"type": "integer"}, "status": {"type": "string"}, "created": {"type": "string", "format": "date-time"}, "updated": {"type": "string", "format": "date-time"}}, "type": "object"}]}, "PaymentMethodUpdate": {"properties": {"name": {"type": "string"}, "priority": {"type": "integer"}, "address": {"$ref": "#/definitions/Address"}}, "type": "object"}, "ChargeInput": {"properties": {"paymentMethodId": {"type": "integer"}, "amount": {"type": "number"}, "invoiceIds": {"type": "array", "items": {"type": "integer"}}}, "type": "object"}, "Charges": {"properties": {"charges": {"type": "array", "items": {"$ref": "#/definitions/Charge"}}, "pageSize": {"type": "integer"}, "total": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "Charge": {"allOf": [{"$ref": "#/definitions/ChargeInput"}, {"properties": {"ownerId": {"type": "integer"}, "chargeId": {"type": "integer"}, "status": {"type": "string"}, "created": {"type": "string", "format": "date-time"}, "updated": {"type": "string", "format": "date-time"}}, "type": "object"}]}, "CollaboratorUpdate": {"properties": {"appUuid": {"type": "string", "description": "App uuid"}, "collaboratorRole": {"type": "string", "description": "Collaborator Role", "example": "ADMIN", "enum": ["ADMIN", "INSTRUCTOR", "MEMBER"]}, "collaboratorStatus": {"type": "string", "description": "Collaborator Status", "example": "ACTIVE", "enum": ["ACTIVE", "INACTIVE", "INVITED"]}}, "type": "object"}, "CollaboratorAccessRole": {"allOf": [{"$ref": "#/definitions/Collaborator"}, {"properties": {"role": {"type": "string", "description": "Access Role", "example": "ADMIN", "enum": ["ADMIN", "INSTRUCTOR", "MEMBER", "OWNER"]}}, "type": "object"}]}, "Collaborator": {"properties": {"accepted": {"type": "string", "format": "date-time", "description": "Accepted date"}, "appId": {"type": "string", "description": "App uuid"}, "collaboratorEmail": {"type": "string", "description": "Email of collaborator"}, "collaboratorId": {"type": "integer", "description": "Id of collaborator"}, "collaboratorRole": {"type": "string", "description": "Collaborator Role", "example": "ADMIN", "enum": ["ADMIN", "INSTRUCTOR", "MEMBER"]}, "collaboratorStatus": {"type": "string", "description": "Collaborator status", "example": "ACTIVE", "enum": ["ACTIVE", "INACTIVE", "INVITED"]}, "created": {"type": "string", "format": "date-time", "description": "Created date"}, "id": {"type": "integer", "description": "Id of collaboration/invitation"}, "invited": {"type": "string", "format": "date-time", "description": "Invitation date"}, "invitedEmail": {"type": "string", "description": "Email where invitation was send"}, "ownerEmail": {"type": "string", "description": "Email of owner"}, "ownerId": {"type": "integer", "description": "Id of owner"}, "orgRole": {"type": "string", "example": "MEMBER", "enum": ["MEMBER", "OWNER"]}, "invitedAsFullUser": {"type": "boolean"}}, "type": "object"}, "CollaboratorCreate": {"properties": {"appUuid": {"type": "string", "description": "App uuid"}, "collaboratorRole": {"type": "string", "description": "Collaborator Role", "example": "ADMIN", "enum": ["ADMIN", "INSTRUCTOR", "MEMBER"]}, "email": {"type": "string", "description": "Email to invite collaborator"}, "invitedAsFullUser": {"type": "boolean"}}, "type": "object"}, "CollaboratorList": {"properties": {"content": {"type": "array", "items": {"$ref": "#/definitions/CollaboratorAccessRole"}}, "last": {"type": "boolean"}, "totalElements": {"type": "integer"}, "totalPages": {"type": "integer"}, "first": {"type": "boolean"}, "numberOfElements": {"type": "integer"}, "size": {"type": "integer"}, "number": {"type": "integer"}}, "type": "object"}, "UserExistsModel": {"properties": {"email": {"type": "string"}, "exists": {"type": "boolean"}, "plan": {"type": "string", "description": "User plan"}}, "type": "object"}, "CollaboratorWithList": {"properties": {"content": {"type": "array", "items": {"$ref": "#/definitions/Collaborator"}}, "last": {"type": "boolean"}, "totalElements": {"type": "integer"}, "totalPages": {"type": "integer"}, "first": {"type": "boolean"}, "numberOfElements": {"type": "integer"}, "size": {"type": "integer"}, "number": {"type": "integer"}}, "type": "object"}, "CollaboratorMetricsList": {"properties": {"collaborator_metrics": {"type": "array", "items": {"$ref": "#/definitions/CollaboratorMetrics"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "CollaboratorMetrics": {"properties": {"collaboratorId": {"type": "integer"}, "quality": {"type": "object", "default": []}, "cost": {"type": "object"}, "speed": {"type": "object"}, "tasksQueued": {"type": "array", "items": {"$ref": "#/definitions/ApiCount"}}, "tasksReviewed": {"type": "array", "items": {"$ref": "#/definitions/ApiCount"}}, "tasksCompleted": {"type": "array", "items": {"$ref": "#/definitions/ApiCount"}}, "periodStart": {"type": "string", "format": "date-time"}, "periodEnd": {"type": "string", "format": "date-time"}}, "type": "object"}, "ApiCount": {"properties": {"apiId": {"type": "string"}, "count": {"type": "integer"}}, "type": "object"}, "JobInput": {"properties": {"callbackUrl": {"type": "string"}, "inputs": {"type": "array", "items": {"type": "object"}}, "inputsFileUrl": {"type": "string"}, "inputsDataUrl": {"type": "string"}, "metadata": {"type": "object"}, "tags": {"type": "array", "items": {"type": "string"}}, "accept_measurement_jobs": {"type": "boolean"}, "pending": {"type": "boolean"}, "labeler": {"type": "string", "example": "owner", "enum": ["owner", "ai", "bots", "crowd"]}, "no_strict": {"type": "boolean", "default": false}, "outputs": {"type": "array", "items": {"type": "object"}}}, "type": "object"}, "JobsList": {"properties": {"jobs": {"type": "array", "items": {"$ref": "#/definitions/Job"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "Job": {"properties": {"id": {"type": "string", "description": "The job instance unique identifier"}, "completed": {"type": "string", "format": "date-time", "description": "time the job was completed"}, "created": {"type": "string", "format": "date-time", "description": "time the job was created"}, "callbackUrl": {"type": "string"}, "appId": {"type": "string", "description": "The app instance unique identifier"}, "status": {"type": "string", "example": "PENDING", "enum": ["PENDING", "COMPLETED", "SCHEDULED", "REVIEWED", "NEEDS_WORK", "IN_PROGRESS", "FAILED", "NEEDS_REVIEW", "EXPIRED", "POST_PROCESSED", "POST_PROCESSING", "SUSPENDED", "CANCELED"]}, "input": {"type": "object"}, "metadata": {"type": "object"}, "tags": {"type": "array", "items": {"type": "string"}}, "uuid": {"type": "string"}, "correct": {"type": "boolean"}, "jobType": {"type": "string"}, "batchId": {"type": "string"}, "score": {"type": "number"}, "trustScore": {"type": "number"}, "workers": {"$ref": "#/definitions/JobWorkers"}, "internalMetadata": {"type": "object"}, "isBigResponse": {"type": "boolean"}}, "type": "object"}, "JobWorkers": {"properties": {"ais": {"type": "array", "items": {"type": "string"}}, "users": {"type": "array", "items": {"type": "string"}}, "crowd": {"type": "boolean"}}, "type": "object"}, "JobSubmitted": {"properties": {"message": {"type": "string"}, "uuid": {"type": "string"}, "truncated_inputs": {"type": "boolean"}, "batch_id": {"type": "string"}}, "type": "object"}, "JobsCountPerState": {"properties": {"SCHEDULED": {"type": "integer"}, "IN_PROGRESS": {"type": "integer"}, "FAILED": {"type": "integer"}, "SUSPENDED": {"type": "integer"}, "CANCELED": {"type": "integer"}, "EXPIRED": {"type": "integer"}, "COMPLETED": {"type": "integer"}, "PENDING": {"type": "integer"}, "NEEDS_WORK": {"type": "integer"}, "REVIEWED": {"type": "integer"}, "POST_PROCESSED": {"type": "integer"}, "NEEDS_REVIEW": {"type": "integer"}, "POST_PROCESSING": {"type": "integer"}}, "type": "object"}, "JobsCountPerProcessingState": {"properties": {"queued": {"type": "integer"}, "correct": {"type": "integer"}, "incorrect": {"type": "integer"}, "parked": {"type": "integer"}, "needsWork": {"type": "integer"}, "completed": {"type": "integer"}, "postProcessing": {"type": "integer"}, "postProcessed": {"type": "integer"}, "needsReview": {"type": "integer"}, "reviewed": {"type": "integer"}, "error": {"type": "integer"}, "expired": {"type": "integer"}, "canceled": {"type": "integer"}, "notReviewed": {"type": "integer"}}, "type": "object"}, "JobIdsList": {"properties": {"jobs": {"type": "array", "items": {"$ref": "#/definitions/JobId"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "JobId": {"properties": {"id": {"type": "integer"}}, "type": "object"}, "JobBatches": {"properties": {"batches": {"type": "array", "items": {"$ref": "#/definitions/JobBatchIndex"}}, "total_jobs": {"type": "integer"}, "total": {"type": "integer"}, "page_size": {"type": "integer"}, "page_number": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "JobBatchIndex": {"properties": {"created": {"type": "string", "format": "date-time"}, "app_uuid": {"type": "string"}, "batch_id": {"type": "string"}, "batch_total": {"type": "integer"}, "batch_processed": {"type": "boolean"}, "invalid_index": {"type": "array", "items": {"type": "integer"}}, "error_message": {"type": "array", "items": {"type": "string"}}, "errors_with_filename": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "JobBatch": {"allOf": [{"$ref": "#/definitions/JobBatchIndex"}, {"properties": {"total_processed": {"type": "integer"}, "valid_count": {"type": "integer"}, "no_strict": {"type": "boolean"}}, "type": "object"}]}, "JobBatchIds": {"properties": {"job_ids": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "JobCanceledDeleted": {"properties": {"jobId": {"type": "integer"}, "operationId": {"type": "integer"}}, "type": "object"}, "JobLabelers": {"properties": {"labelers": {"type": "array", "items": {"$ref": "#/definitions/JobLabelerInfo"}}}, "type": "object"}, "JobLabelerInfo": {"properties": {"id": {"type": "integer"}, "email": {"type": "string"}}, "type": "object"}, "JobInfo": {"properties": {"feedbacks": {"type": "array", "items": {"type": "object"}}, "response": {"type": "object"}, "status": {"type": "string"}, "responseData": {"type": "string"}}, "type": "object"}, "JobCanceled": {"properties": {"canceled": {"type": "integer"}, "errorInProgressIds": {"type": "array", "items": {"type": "integer"}}, "operationId": {"type": "integer"}}, "type": "object"}, "JobDeleted": {"properties": {"deleted": {"type": "integer"}, "errorInProgressIds": {"type": "array", "items": {"type": "integer"}}, "operationId": {"type": "integer"}}, "type": "object"}, "JobSubmittedRelabel": {"properties": {"message": {"type": "string"}, "uuid": {"type": "string"}, "batch_id": {"type": "string"}, "operation_id": {"type": "integer"}}, "type": "object"}, "JobsOperation": {"properties": {"operationId": {"type": "integer"}}, "type": "object"}, "JobResponse": {"properties": {"response": {"type": "object"}, "responseData": {"type": "string"}}, "type": "object"}, "JobReview": {"allOf": [{"$ref": "#/definitions/JobResponse"}, {"properties": {"correct": {"type": "boolean"}}, "type": "object"}]}, "JobReviewOutput": {"allOf": [{"$ref": "#/definitions/JobReview"}, {"properties": {"baselineId": {"type": "integer"}, "operationId": {"type": "integer"}}, "type": "object"}]}, "JobsHistoryList": {"properties": {"history": {"type": "array", "items": {"$ref": "#/definitions/JobHistory"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "JobHistory": {"properties": {"version": {"type": "string"}, "relabelId": {"type": "integer"}, "completed": {"type": "string", "format": "date-time"}, "status": {"type": "string", "example": "PENDING", "enum": ["PENDING", "COMPLETED", "SCHEDULED", "REVIEWED", "NEEDS_WORK", "IN_PROGRESS", "FAILED", "NEEDS_REVIEW", "EXPIRED", "POST_PROCESSED", "POST_PROCESSING", "SUSPENDED", "CANCELED"]}, "correct": {"type": "boolean"}, "feedback": {"type": "object"}, "jobId": {"type": "integer"}, "originalJobId": {"type": "integer"}, "created": {"type": "string", "format": "date-time"}, "jobCreated": {"type": "string", "format": "date-time"}, "jobCreatedEdited": {"type": "string", "format": "date-time"}, "versionJobId": {"type": "integer"}}, "type": "object"}, "JobCollaborator": {"allOf": [{"$ref": "#/definitions/Job"}, {"properties": {"appParams": {"type": "object"}}, "type": "object"}]}, "JobLabel": {"allOf": [{"$ref": "#/definitions/JobResponse"}, {"properties": {"feedback": {"type": "object"}, "action": {"type": "string", "example": "RESOLVE", "enum": ["RESOLVE", "REJECT"]}}, "type": "object"}]}, "JobTags": {"properties": {"tags": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "CreateFeedbackMessage": {"properties": {"response": {"type": "string"}, "correct": {"type": "boolean"}, "message": {"type": "string"}, "taskId": {"type": "integer"}, "collabTaskId": {"type": "integer"}}, "type": "object"}, "FeedbackMessageView": {"properties": {"id": {"type": "integer"}, "message": {"type": "string"}, "created": {"type": "string", "format": "date-time"}, "updated": {"type": "string", "format": "date-time"}, "correct": {"type": "boolean"}, "response": {"type": "object"}, "feedbackConversationId": {"type": "string"}, "state": {"type": "string", "example": "ACTIVE", "enum": ["ACTIVE", "DELETED", "FLAGGED"]}, "ownerId": {"type": "integer"}, "ownerEmail": {"type": "string"}, "labelerId": {"type": "integer"}, "labelerEmail": {"type": "string"}, "workerId": {"type": "string"}, "tag": {"$ref": "#/definitions/feedback_tag"}, "viewState": {"type": "string"}, "taskId": {"type": "string"}, "labelerTaskId": {"type": "string"}}, "type": "object"}, "feedback_tag": {"properties": {"id": {"type": "integer"}, "parentId": {"type": "integer"}, "tag": {"type": "string"}, "active": {"type": "boolean"}, "position": {"type": "integer"}, "created": {"type": "string", "format": "date-time"}, "updated": {"type": "string", "format": "date-time"}, "checkbox": {"type": "boolean"}, "textField": {"type": "string"}, "editable": {"type": "boolean"}, "value": {"type": "string"}}, "type": "object"}, "JobsWithFeedbackMessageList": {"properties": {"jobs": {"type": "array", "items": {"$ref": "#/definitions/JobWithFeedbackMessage"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "JobWithFeedbackMessage": {"allOf": [{"$ref": "#/definitions/Job"}, {"properties": {"feedbackMessage": {"$ref": "#/definitions/FeedbackMessageView"}, "feedbackTags": {"type": "array", "items": {"$ref": "#/definitions/feedback_tag"}}}, "type": "object"}]}, "CreateLabelerFeedback": {"properties": {"jobId": {"type": "integer"}, "collabTaskId": {"type": "integer"}, "feedbackOptions": {"type": "string"}, "selectedFeedbackOptions": {"type": "string"}}, "type": "object"}, "JobComplete": {"properties": {"response": {"type": "object"}, "workers": {"$ref": "#/definitions/JobWorkers"}}, "type": "object"}, "JobBigPayloadResponse": {"properties": {"url": {"type": "string"}}, "type": "object"}, "JobsAuditList": {"properties": {"audit": {"type": "array", "items": {"$ref": "#/definitions/JobAudit"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "JobAudit": {"properties": {"id": {"type": "integer"}, "created": {"type": "string", "format": "date-time"}, "action": {"type": "string", "example": "CORRECT", "enum": ["CORRECT", "INCORRECT", "EDIT", "RELABEL"]}, "ownerId": {"type": "integer"}}, "type": "object"}, "JobDiff": {"properties": {"jobId": {"type": "integer"}, "diffMD": {"type": "string"}, "originalDiffs": {"type": "array", "items": {"type": "string"}}, "revisionDiffs": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "JobViewingUsers": {"properties": {"viewers": {"type": "array", "items": {"$ref": "#/definitions/JobViewingUser"}}}, "type": "object"}, "JobViewingUser": {"properties": {"userEmail": {"type": "string"}}, "type": "object"}, "DesiredAppMetrics": {"properties": {"appMetrics": {"type": "string", "description": "App metrics"}}, "type": "object"}, "MetricConstraintReturn": {"properties": {"content": {"type": "array", "items": {"$ref": "#/definitions/MetricConstraint"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "MetricConstraint": {"properties": {"id": {"type": "integer"}, "name": {"type": "string"}, "ownerId": {"type": "integer"}}, "type": "object"}, "MeasurerConfigurationUpdate": {"properties": {"sample_strategy": {"type": "string", "example": "newest", "enum": ["newest", "random"]}, "sample_size": {"type": "integer", "minimum": 1}, "measure_frequency": {"type": "string", "example": "manual", "enum": ["manual", "daily", "weekly", "monthly"]}, "dataset_ids": {"type": "array", "minItems": 1, "maxItems": 1, "items": {"type": "string"}}}, "type": "object"}, "MeasurerConfiguration": {"properties": {"sample_strategy": {"type": "string", "example": "newest", "enum": ["newest", "random"]}, "sample_size": {"type": "integer", "minimum": 1}, "measure_frequency": {"type": "string", "example": "manual", "enum": ["manual", "daily", "weekly", "monthly"]}, "default_dataset_id": {"type": "string"}, "app_id": {"type": "string"}, "created_at": {"type": "string", "format": "date-time"}, "updated_at": {"type": "string", "format": "date-time"}}, "type": "object"}, "AppMetric": {"properties": {"metric_name": {"type": "string"}}, "type": "object"}, "MeasurerMetric": {"required": ["name"], "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "description": {"type": "string"}}, "type": "object"}, "OperationCreate": {"required": ["type"], "properties": {"type": {"type": "string", "example": "app_measurement", "enum": ["app_measurement"]}}, "type": "object"}, "OperationReturn": {"properties": {"id": {"type": "string"}, "app_id": {"type": "string"}, "created_at": {"type": "string", "format": "date-time"}, "state": {"type": "string"}, "type": {"type": "string"}}, "type": "object"}, "MeasurementResponse": {"properties": {"app_id": {"type": "string"}, "records": {"type": "array", "items": {"$ref": "#/definitions/MeasurementRecord"}}}, "type": "object"}, "MeasurementRecord": {"properties": {"field_name": {"type": "string"}, "metric_name": {"type": "string"}, "value": {"type": "number"}, "created_at": {"type": "string", "format": "date-time"}, "dataset_id": {"type": "string"}, "parameter_set_id": {"type": "string"}}, "type": "object"}, "ConfidencesResponse": {"properties": {"dataset_id": {"type": "string"}, "jobs": {"type": "object", "description": "A dictionary where each key is a string, and each value is a list of dictionaries with fields that may be bool/int/float."}}, "type": "object"}, "TagInput": {"properties": {"name": {"type": "string", "description": "Unique name of the tag"}, "templates": {"type": "array", "items": {"type": "string"}}, "collaborators": {"type": "array", "items": {"type": "string"}}, "datasets": {"type": "array", "items": {"type": "string"}}, "apis": {"type": "array", "items": {"type": "string"}}, "jobs": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "TagsReturn": {"properties": {"tags": {"type": "array", "items": {"$ref": "#/definitions/Tag"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "Tag": {"allOf": [{"$ref": "#/definitions/TagInput"}, {"properties": {"uuid": {"type": "string", "description": "The tag unique identifier"}, "createdDate": {"type": "string", "format": "date", "description": "Time the tag was created"}}, "type": "object"}]}, "TestUrlInput": {"properties": {"inputs": {"type": "array", "items": {"type": "object", "description": "Unique name of the tag"}}}, "type": "object"}, "OnboardingCode": {"properties": {"code": {"type": "integer", "description": "Code for onboarding"}}, "type": "object"}, "OnboardingUUID": {"properties": {"uuid": {"type": "string", "description": "UUID for onboarding"}}, "type": "object"}, "TaskUpdate": {"properties": {"completed": {"type": "string", "format": "date-time"}, "feedback": {"type": "object"}, "values": {"type": "object"}}, "type": "object"}, "TrainingExampleModel": {"properties": {"id": {"type": "integer"}, "trainingId": {"type": "integer"}, "input": {"type": "object"}, "metadata": {"type": "object"}, "inputSchema": {"type": "object"}, "outputSchema": {"type": "object"}, "inputUiSchema": {"type": "object"}, "outputUiSchema": {"type": "object"}, "response": {"type": "object"}, "appParams": {"type": "object"}, "isInteractive": {"type": "boolean"}, "sequence": {"type": "integer"}, "hint": {"type": "string"}, "explanation": {"type": "string"}}, "type": "object"}, "TaskBigPayloadResponse": {"properties": {"url": {"type": "string"}}, "type": "object"}, "CollabTaskUpdate": {"properties": {"completed": {"type": "string", "format": "date-time"}, "feedback": {"type": "object"}, "values": {"type": "object"}}, "type": "object"}, "CollabTaskInProgCount": {"properties": {"count": {"type": "integer"}}, "type": "object"}, "CollaboratorTaskBigPayloadResponse": {"properties": {"url": {"type": "string"}}, "type": "object"}, "Contact": {"properties": {"title": {"type": "string"}, "phone": {"type": "string"}, "company": {"type": "string"}, "email": {"type": "string"}, "description": {"type": "string"}}, "type": "object"}, "Hero": {"properties": {"id": {"type": "string"}, "email": {"type": "string"}, "firstname": {"type": "string"}, "lastname": {"type": "string"}}, "type": "object"}, "UpdateHeroStatus": {"properties": {"hero_uuid": {"type": "string"}, "app_uuid": {"type": "string"}, "reason": {"type": "string"}, "status": {"type": "string", "example": "ACTIVE", "enum": ["ACTIVE", "BANNED"]}}, "type": "object"}, "OrganizationList": {"properties": {"content": {"type": "array", "items": {"$ref": "#/definitions/OrganizationMember"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "CreateInvitationRequest": {"properties": {"email": {"type": "string"}, "role": {"type": "string", "example": "MEMBER", "enum": ["MEMBER", "OWNER"]}}, "type": "object"}, "UpdateOrganizationMemberRequest": {"properties": {"status": {"type": "string", "example": "INVITED", "enum": ["INVITED", "ACTIVE", "INACTIVE"]}, "role": {"type": "string", "example": "MEMBER", "enum": ["MEMBER", "OWNER"]}}, "type": "object"}, "CreateWorker": {"required": ["type"], "properties": {"email": {"type": "string"}, "type": {"type": "string", "example": "USER", "enum": ["USER", "CROWD", "BOT", "AI"]}}, "type": "object"}, "WorkerList": {"properties": {"content": {"type": "array", "items": {"$ref": "#/definitions/WorkerFromList"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "WorkerFromList": {"allOf": [{"$ref": "#/definitions/Worker"}, {"properties": {"groupsTotal": {"type": "integer"}}, "type": "object"}]}, "Worker": {"properties": {"id": {"type": "integer"}, "status": {"type": "string", "example": "INVITED", "enum": ["INVITED", "ACTIVE", "INACTIVE"]}, "type": {"type": "string", "example": "USER", "enum": ["USER", "CROWD", "BOT", "AI"]}, "invited": {"type": "string", "format": "date-time"}, "accepted": {"type": "string", "format": "date-time"}, "created": {"type": "string", "format": "date-time"}, "userId": {"type": "integer"}, "userEmail": {"type": "string"}, "userUsername": {"type": "string"}}, "type": "object"}, "WorkerAppList": {"properties": {"content": {"type": "array", "items": {"$ref": "#/definitions/WorkerApp"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "WorkerApp": {"properties": {"appUuid": {"type": "string"}, "created": {"type": "string", "format": "date-time"}, "ownerId": {"type": "integer"}, "worker": {"$ref": "#/definitions/Worker"}, "role": {"type": "string", "example": "LABELER", "enum": ["LABELER", "REVIEWER"]}}, "type": "object"}, "CreateWorkerApp": {"required": ["role"], "properties": {"role": {"type": "string", "example": "LABELER", "enum": ["LABELER", "REVIEWER"]}}, "type": "object"}, "CreateWorkerGroup": {"required": ["name"], "properties": {"name": {"type": "string"}, "workerIds": {"type": "array", "items": {"type": "integer"}}}, "type": "object"}, "WorkerGroupList": {"properties": {"content": {"type": "array", "items": {"$ref": "#/definitions/WorkerGroup"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "WorkerGroup": {"properties": {"id": {"type": "integer"}, "created": {"type": "string"}, "name": {"type": "string"}, "ownerId": {"type": "integer"}, "workers": {"type": "array", "items": {"$ref": "#/definitions/Worker"}}}, "type": "object"}, "UpdateWorkerGroup": {"properties": {"name": {"type": "string"}, "workerIds": {"type": "array", "items": {"type": "integer"}}}, "type": "object"}, "WorkerGroupAppList": {"properties": {"content": {"type": "array", "items": {"$ref": "#/definitions/WorkerGroupApp"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "WorkerGroupApp": {"properties": {"appUuid": {"type": "string"}, "created": {"type": "string", "format": "date-time"}, "ownerId": {"type": "integer"}, "workerGroupId": {"type": "integer"}, "workerGroupName": {"type": "string"}, "role": {"type": "string", "example": "LABELER", "enum": ["LABELER", "REVIEWER"]}}, "type": "object"}, "CreateWorkerGroupApp": {"required": ["role"], "properties": {"role": {"type": "string", "example": "LABELER", "enum": ["LABELER", "REVIEWER"]}}, "type": "object"}, "OperationsList": {"properties": {"content": {"type": "array", "items": {"$ref": "#/definitions/Operation"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "Operation": {"properties": {"id": {"type": "integer"}, "appUuid": {"type": "string"}, "created": {"type": "string", "format": "date-time"}, "started": {"type": "string", "format": "date-time"}, "completed": {"type": "string", "format": "date-time"}, "status": {"type": "string", "example": "SCHEDULED", "enum": ["SCHEDULED", "IN_PROGRESS", "COMPLETED", "FAILED", "ARCHIVED"]}, "type": {"type": "string", "example": "APP_UPDATED", "enum": ["APP_UPDATED", "CANCEL", "DELETE", "DOWNLOAD", "START", "RELABEL", "POST_PROCESS"]}, "jobUuid": {"type": "string"}}, "type": "object"}, "DownloadsJobsUrl": {"properties": {"downloadUrl": {"type": "string"}}, "type": "object"}, "CustomerPage": {"properties": {"customers": {"type": "array", "items": {"$ref": "#/definitions/Customer"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "Customer": {"properties": {"username": {"type": "string"}, "email": {"type": "string"}, "plan": {"type": "string", "example": "FREEMIUM", "enum": ["FREEMIUM", "FULL"]}, "created": {"type": "string", "format": "date-time"}, "updated": {"type": "string", "format": "date-time"}, "enabled": {"type": "boolean"}, "trialDays": {"type": "integer"}, "deleted": {"type": "boolean"}}, "type": "object"}, "JobTasksInfoList": {"properties": {"tasks": {"type": "array", "items": {"$ref": "#/definitions/JobTaskInfo"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "JobTaskInfo": {"properties": {"actions": {"type": "object"}, "completed": {"type": "string", "format": "date-time"}, "created": {"type": "string", "format": "date-time"}, "id": {"type": "integer"}, "input": {"type": "object"}, "labelerType": {"type": "string", "example": "COLLABORATOR", "enum": ["COLLABORATOR", "HERO", "AI"]}, "output": {"type": "object"}, "response": {"type": "object"}, "schemaVersion": {"type": "string"}, "status": {"type": "string", "example": "SCHEDULED", "enum": ["SCHEDULED", "IN_PROGRESS", "PENDING", "EXPIRED", "COMPLETED", "CANCELED"]}, "taskInfo": {"type": "object"}, "title": {"type": "string"}, "type": {"type": "string"}, "labeler": {"type": "string"}, "labelerUsername": {"type": "string", "description": "Username of labeler. Present only if labelerType is COLLABORATOR."}, "labelerId": {"type": "integer", "description": "Worker ID of labeler. Present only if labelerType is HERO and API key for SYSADMIN or SYSCROWDNAMAGER is being used."}, "labelerStatus": {"type": "string", "example": "ACTIVE", "enum": ["ACTIVE", "INACTIVE", "DELETED"]}, "labelingTime": {"type": "integer"}, "correct": {"type": "boolean"}, "confidence": {"type": "number"}}, "type": "object"}, "TaskReview": {"properties": {"correct": {"type": "boolean"}}, "type": "object"}, "TaskDistribution": {"properties": {"totalAi": {"type": "integer"}, "totalCrowd": {"type": "integer"}, "totalUser": {"type": "integer"}, "weekTaskDistribution": {"type": "array", "items": {"$ref": "#/definitions/DayTaskDistribution"}}}, "type": "object"}, "DayTaskDistribution": {"properties": {"dayAi": {"type": "integer"}, "dayCrowd": {"type": "integer"}, "dayUser": {"type": "integer"}}, "type": "object"}, "AppDownloadTasks": {"properties": {"operationId": {"type": "integer"}}, "type": "object"}, "TaskOperationsList": {"properties": {"content": {"type": "array", "items": {"$ref": "#/definitions/TaskOperation"}}, "total": {"type": "integer"}, "pageSize": {"type": "integer"}, "pageNumber": {"type": "integer"}, "pages": {"type": "integer"}}, "type": "object"}, "TaskOperation": {"properties": {"id": {"type": "integer"}, "appUuid": {"type": "string"}, "created": {"type": "string", "format": "date-time"}, "started": {"type": "string", "format": "date-time"}, "completed": {"type": "string", "format": "date-time"}, "status": {"type": "string", "example": "SCHEDULED", "enum": ["SCHEDULED", "IN_PROGRESS", "COMPLETED", "FAILED"]}, "type": {"type": "string", "example": "DOWNLOAD", "enum": ["DOWNLOAD"]}}, "type": "object"}, "DownloadsTasksUrl": {"properties": {"downloadUrl": {"type": "string"}}, "type": "object"}, "TaskTemplate": {"allOf": [{"$ref": "#/definitions/Template"}, {"properties": {"defaultWorkers": {"type": "object"}, "defaultParameters": {"type": "object"}}, "type": "object"}]}, "DataUploadModel": {"required": ["path"], "properties": {"path": {"type": "string", "description": "the path where the data is uploaded in the data bucket"}, "description": {"type": "string", "description": "The uploaded data's description"}, "mime_type": {"type": "string", "description": "The mime type of the uploaded data"}}, "type": "object"}, "SubmitJobModel": {"required": ["source_bucket"], "properties": {"source_bucket": {"type": "string", "description": "The source bucket the data copied from"}, "folder": {"type": "string", "description": "The folder to start the batch processing"}, "source_folder": {"type": "string", "description": "The source folder the data copied from"}, "file": {"type": "string", "description": "The file to start single job process"}, "source_key": {"type": "string", "description": "The source key the data copied from"}}, "type": "object"}, "SchemaInput": {"required": ["appParams", "templateName"], "properties": {"templateName": {"type": "string", "description": "The class of the app instance"}, "appParams": {"type": "object"}}, "type": "object"}, "SchemaOutput": {"properties": {"inputSchema": {"type": "object"}, "inputUiSchema": {"type": "object"}, "outputSchema": {"type": "object"}, "outputUiSchema": {"type": "object"}}, "type": "object"}, "VerificationModel": {"properties": {"is_verified": {"type": "boolean"}}, "type": "object"}, "InboxModel": {"properties": {"id": {"type": "string"}, "address": {"type": "string"}}, "type": "object"}, "FieldDatasetInput": {"required": ["data"], "properties": {"data": {"type": "string", "description": "CSV file encoded as string for the field dataset"}}, "type": "object"}, "FieldDataset": {"properties": {"data": {"type": "string", "description": "CSV Data of the field dataset"}}, "type": "object"}, "FieldParamDatasets": {"properties": {"data": {"type": "array", "items": {"$ref": "#/definitions/GetFieldParamDatasets"}}}, "type": "object"}, "GetFieldParamDatasets": {"properties": {"datasets": {"type": "array", "items": {"type": "string"}}, "name": {"type": "string"}, "id": {"type": "string"}}, "type": "object"}, "FieldParamDatasetsUpdateInput": {"properties": {"states": {"type": "array", "items": {"type": "string"}}, "datasets": {"type": "array", "items": {"type": "string"}}}, "type": "object"}}, "responses": {"ParseError": {"description": "When a mask can't be parsed"}, "MaskError": {"description": "When any error occurs on mask"}, "BadRequest": {"description": "The browser (or proxy) sent a request that this server could not understand"}, "Unauthorized": {"description": "The server could not verify that you are authorized to access the URL requested"}, "Forbidden": {"description": "You don't have the permission to access the requested resource"}, "NotFound": {"description": "The requested URL was not found on the server"}, "MethodNotAllowed": {"description": "The method is not allowed for the requested URL"}, "NotAcceptable": {"description": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request"}, "RequestTimeout": {"description": "The server closed the network connection because the browser didn't finish the request within the specified time"}, "Conflict": {"description": "A conflict happened while processing the request"}, "Gone": {"description": "The requested URL is no longer available on this server and there is no forwarding address"}, "LengthRequired": {"description": "A request with this method requires a valid <code>Content-Length</code> header"}, "PreconditionFailed": {"description": "The precondition on the request for the URL failed positive evaluation"}, "RequestEntityTooLarge": {"description": "The data value transmitted exceeds the capacity limit"}, "RequestURITooLarge": {"description": "The length of the requested URL exceeds the capacity limit for this server"}, "UnsupportedMediaType": {"description": "The server does not support the media type transmitted in the request"}, "RequestedRangeNotSatisfiable": {"description": "The server cannot provide the requested range"}, "ExpectationFailed": {"description": "The server could not meet the requirements of the Expect header"}, "ImATeapot": {"description": "This server is a teapot, not a coffee machine"}, "MisdirectedRequest": {"description": "The server is not able to produce a response"}, "UnprocessableEntity": {"description": "The request was well-formed but was unable to be followed due to semantic errors"}, "Locked": {"description": "The resource that is being accessed is locked"}, "FailedDependency": {"description": "The method could not be performed on the resource because the requested action depended on another action and that action failed"}, "PreconditionRequired": {"description": "This request is required to be conditional; try using \"If-Match\" or \"If-Unmodified-Since\""}, "_RetryAfter": {"description": "No description available"}, "RequestHeaderFieldsTooLarge": {"description": "One or more header fields exceeds the maximum size"}, "UnavailableForLegalReasons": {"description": "Unavailable for legal reasons"}, "NotImplemented": {"description": "The server does not support the action requested by the browser"}, "BadGateway": {"description": "The proxy server received an invalid response from an upstream server"}, "GatewayTimeout": {"description": "The connection to an upstream server timed out"}, "HTTPVersionNotSupported": {"description": "The server does not support the HTTP protocol version used in the request"}, "RequestRedirect": {"description": "No description available"}, "InvalidJobInput": {"description": "Job inputs not valid"}, "InvalidJobLabel": {"description": "Job label not valid"}, "PaymentRequired": {"description": "Payment Required"}, "InvalidBaselineInput": {"description": "Ground truth input not valid"}, "InvalidBaselineLabel": {"description": "Ground truth label not valid"}, "DataDuplicated": {"description": "File already exists in your dataset"}, "DataFilenameLength": {"description": "Filename length exceeds max allowed characters"}, "DataUpload": {"description": "File upload failed"}, "OrganizationMemberNotFound": {"description": "API-Key user is not a member of the organization"}, "InvalidContact": {"description": "Title, email, and description are required"}, "CollaboratorAlreadyInvited": {"description": "Collaborator already invited"}, "InboxNotFoundException": {"description": "Inbox for specified application does not exist"}}, "host": "api.prod-eu.super.ai"}