List
GET/jobs
List all jobs matching the given filters. A job is a synchronous operation or an asynchronous task such as a training, a generation, etc. It offers a unified view of all operations running on the platform along with their status and results. A page can hold fewer jobs than “pageSize”, or none, while “nextPaginationToken” is set: keep paginating until it is absent.
Query Parameters
createdAfter: optional string
Only return the jobs created after this date (ISO 8601). Only allowed without “status”, “type”, “types” and “workflowId”, which sort jobs by update date: use “updatedAfter” with them. Overrides the 30-day window applied with “authorId” or “hideResults=false”. Optional.
hideResults: optional boolean
If false, jobs submitted with “hideResults”: true are not returned. When false, only jobs from the last 30 days are returned (by creation date, or by update date when “status”, “type”, “types” or “workflowId” is set) unless “createdAfter” or “updatedAfter” is set. Optional.
pageSize: optional number
The number of items to return in the response. The default value is 50, maximum value is 100, minimum value is 1
minimum1
maximum100
paginationToken: optional string
A token you received in a previous request to query the next page of items
projectId: optional string
The projectId used for ownership resource management. Either to assert ownership or to set the owner of the resource(s)
List
curl https://api.cloud.scenario.com/v1/jobs \
-u "$SCENARIO_SDK_API_KEY:SCENARIO_SDK_API_SECRET"{
"jobs": [
{
"createdAt": "createdAt",
"jobId": "jobId",
"jobType": "assets-download",
"metadata": {
"assetIds": [
"string"
],
"error": "error",
"flow": [
{
"id": "id",
"status": "failure",
"type": "custom-model",
"assets": [
{
"assetId": "assetId",
"url": "url"
}
],
"count": 0,
"dependsOn": [
"string"
],
"includeOutputsInWorkflowJob": true,
"inputs": [
{
"name": "name",
"type": "boolean",
"allowedValues": [
{}
],
"backgroundBehavior": "opaque",
"color": true,
"costImpact": true,
"default": {},
"description": "description",
"group": "group",
"hint": "hint",
"inputs": [
{
"foo": "bar"
}
],
"items": [
[
{
"name": "name",
"type": "boolean",
"allowedValues": [
{}
],
"backgroundBehavior": "opaque",
"color": true,
"costImpact": true,
"default": {},
"description": "description",
"group": "group",
"hint": "hint",
"inputs": [
{
"foo": "bar"
}
],
"kind": "3d",
"label": "label",
"maskFrom": "maskFrom",
"max": 0,
"maxDuration": 0,
"maxLength": 0,
"maxSize": 0,
"min": 0,
"minLength": 0,
"modelTypes": [
"custom"
],
"parent": true,
"placeholder": "placeholder",
"prompt": true,
"promptSpark": true,
"ref": {
"conditional": [
"string"
],
"equal": "equal",
"name": "name",
"node": "node"
},
"required": {
"always": true,
"conditional": {
"values": {},
"operator": "and"
},
"ifDefined": {},
"ifNotDefined": {}
},
"step": 1,
"value": {}
}
]
],
"kind": "3d",
"label": "label",
"maskFrom": "maskFrom",
"max": 0,
"maxDuration": 0,
"maxLength": 0,
"maxSize": 0,
"min": 0,
"minLength": 0,
"modelTypes": [
"custom"
],
"parent": true,
"placeholder": "placeholder",
"prompt": true,
"promptSpark": true,
"ref": {
"conditional": [
"string"
],
"equal": "equal",
"name": "name",
"node": "node"
},
"required": {
"always": true,
"conditional": {
"values": {},
"operator": "and"
},
"ifDefined": {},
"ifNotDefined": {}
},
"step": 1,
"value": {}
}
],
"items": [
"string"
],
"iterationIndex": 0,
"jobId": "jobId",
"logic": {
"cases": [
{
"condition": "condition",
"value": "value"
}
],
"default": "default",
"transform": "transform"
},
"logicType": "if-else",
"loopBodyNodeIds": [
"string"
],
"loopNodeId": "loopNodeId",
"modelId": "modelId",
"output": {},
"workflowId": "workflowId"
}
],
"hint": "hint",
"input": {
"foo": "bar"
},
"output": {
"foo": "bar"
},
"outputModelId": "outputModelId",
"workflowId": "workflowId",
"workflowJobId": "workflowJobId"
},
"progress": 0,
"status": "canceled",
"statusHistory": [
{
"date": "date",
"status": "canceled"
}
],
"updatedAt": "updatedAt",
"authorId": "authorId",
"billing": {
"cuCost": 0,
"cuDiscount": 0,
"cuCostDetails": {
"ip-detection": 0,
"quality-gate": 0
},
"disableRefund": true
},
"ownerId": "ownerId"
}
],
"nextPaginationToken": "nextPaginationToken"
}Returns Examples
{
"jobs": [
{
"createdAt": "createdAt",
"jobId": "jobId",
"jobType": "assets-download",
"metadata": {
"assetIds": [
"string"
],
"error": "error",
"flow": [
{
"id": "id",
"status": "failure",
"type": "custom-model",
"assets": [
{
"assetId": "assetId",
"url": "url"
}
],
"count": 0,
"dependsOn": [
"string"
],
"includeOutputsInWorkflowJob": true,
"inputs": [
{
"name": "name",
"type": "boolean",
"allowedValues": [
{}
],
"backgroundBehavior": "opaque",
"color": true,
"costImpact": true,
"default": {},
"description": "description",
"group": "group",
"hint": "hint",
"inputs": [
{
"foo": "bar"
}
],
"items": [
[
{
"name": "name",
"type": "boolean",
"allowedValues": [
{}
],
"backgroundBehavior": "opaque",
"color": true,
"costImpact": true,
"default": {},
"description": "description",
"group": "group",
"hint": "hint",
"inputs": [
{
"foo": "bar"
}
],
"kind": "3d",
"label": "label",
"maskFrom": "maskFrom",
"max": 0,
"maxDuration": 0,
"maxLength": 0,
"maxSize": 0,
"min": 0,
"minLength": 0,
"modelTypes": [
"custom"
],
"parent": true,
"placeholder": "placeholder",
"prompt": true,
"promptSpark": true,
"ref": {
"conditional": [
"string"
],
"equal": "equal",
"name": "name",
"node": "node"
},
"required": {
"always": true,
"conditional": {
"values": {},
"operator": "and"
},
"ifDefined": {},
"ifNotDefined": {}
},
"step": 1,
"value": {}
}
]
],
"kind": "3d",
"label": "label",
"maskFrom": "maskFrom",
"max": 0,
"maxDuration": 0,
"maxLength": 0,
"maxSize": 0,
"min": 0,
"minLength": 0,
"modelTypes": [
"custom"
],
"parent": true,
"placeholder": "placeholder",
"prompt": true,
"promptSpark": true,
"ref": {
"conditional": [
"string"
],
"equal": "equal",
"name": "name",
"node": "node"
},
"required": {
"always": true,
"conditional": {
"values": {},
"operator": "and"
},
"ifDefined": {},
"ifNotDefined": {}
},
"step": 1,
"value": {}
}
],
"items": [
"string"
],
"iterationIndex": 0,
"jobId": "jobId",
"logic": {
"cases": [
{
"condition": "condition",
"value": "value"
}
],
"default": "default",
"transform": "transform"
},
"logicType": "if-else",
"loopBodyNodeIds": [
"string"
],
"loopNodeId": "loopNodeId",
"modelId": "modelId",
"output": {},
"workflowId": "workflowId"
}
],
"hint": "hint",
"input": {
"foo": "bar"
},
"output": {
"foo": "bar"
},
"outputModelId": "outputModelId",
"workflowId": "workflowId",
"workflowJobId": "workflowJobId"
},
"progress": 0,
"status": "canceled",
"statusHistory": [
{
"date": "date",
"status": "canceled"
}
],
"updatedAt": "updatedAt",
"authorId": "authorId",
"billing": {
"cuCost": 0,
"cuDiscount": 0,
"cuCostDetails": {
"ip-detection": 0,
"quality-gate": 0
},
"disableRefund": true
},
"ownerId": "ownerId"
}
],
"nextPaginationToken": "nextPaginationToken"
}