v1/jobs/workflow

POST 
/v1/jobs/workflow

create workflow job

Request

application/json

Body

required

requestId string
params object
property name* object
classType string
inputs object
properties object
runningNotifyUrl string

Responses

200

OK

application/json

Schema

Schema

job object
id uint64
job id
status string
Possible values: [DEFAULT, CREATED, PENDING, RUNNING, CANCELED, SUCCESS, FAILED, WAITING]
Default value: DEFAULT
job status
credits double
waitingInfo object
waiting info, when status is waiting will return this
queueRank int64
queueLen int64
failedInfo object
failed info, when status is failed will return this
reason string
code string
Possible values: [DEFAULT, TRANSITORY_ERROR, FATAL_ERROR]
Default value: DEFAULT
runningInfo object
running info, when status is running will return this
processingImages object[]
Array [
resourceImage object
id string
url string
expiredIn int64
meta object
image object
format string
width int32
height int32
progress double
]
workflowFinishItem object
status string
Possible values: [DEFAULT, INIT, RUNNING, SUCCESS, FAILED]
Default value: DEFAULT
progress double
step int32
id string
ctime int64
mtime int64
nodes object
property name* object
id string
status string
Possible values: [DEFAULT, INIT, RUNNING, SUCCESS, FAILED]
Default value: DEFAULT
process double
outputUi object
type string
images object[]
Array [
filename string
type string
height int32
width int32
format string
imageResourceId string
]
finishedNodes object
property name* boolean
successInfo object
success info, when status is success will return this
images object[]
final output images
Array [
id string
url string
expiredIn int64
meta object
image object
format string
width int32
height int32
]
videos object[]
final output videos
Array [
id string
url string
expiredIn int64
meta object
image object
format string
width int32
height int32
]
workflowFinishItem object
status string
Possible values: [DEFAULT, INIT, RUNNING, SUCCESS, FAILED]
Default value: DEFAULT
progress double
step int32
id string
ctime int64
mtime int64
nodes object
property name* object
id string
status string
Possible values: [DEFAULT, INIT, RUNNING, SUCCESS, FAILED]
Default value: DEFAULT
process double
outputUi object
type string
images object[]
Array [
filename string
type string
height int32
width int32
format string
imageResourceId string
]
finishedNodes object
property name* boolean

Example (from schema)

{
  "job": {
    "id": "string",
    "status": "DEFAULT",
    "credits": 0,
    "waitingInfo": {
      "queueRank": "string",
      "queueLen": "string"
    },
    "failedInfo": {
      "reason": "string",
      "code": "DEFAULT"
    },
    "runningInfo": {
      "processingImages": [
        {
          "resourceImage": {
            "id": "string",
            "url": "string",
            "expiredIn": "string",
            "meta": {
              "image": {
                "format": "string",
                "width": 0,
                "height": 0
              }
            }
          },
          "progress": 0
        }
      ],
      "workflowFinishItem": {
        "status": "DEFAULT",
        "progress": 0,
        "step": 0,
        "id": "string",
        "ctime": "string",
        "mtime": "string",
        "nodes": {},
        "finishedNodes": {}
      }
    },
    "successInfo": {
      "images": [
        {
          "id": "string",
          "url": "string",
          "expiredIn": "string",
          "meta": {
            "image": {
              "format": "string",
              "width": 0,
              "height": 0
            }
          }
        }
      ],
      "videos": [
        {
          "id": "string",
          "url": "string",
          "expiredIn": "string",
          "meta": {
            "image": {
              "format": "string",
              "width": 0,
              "height": 0
            }
          }
        }
      ],
      "workflowFinishItem": {
        "status": "DEFAULT",
        "progress": 0,
        "step": 0,
        "id": "string",
        "ctime": "string",
        "mtime": "string",
        "nodes": {},
        "finishedNodes": {}
      }
    }
  }
}

400

Bad Request: general error for invalid parameters More specific errors:

• invalid_samples: Sample count may only be greater then 1
• invalid_height_or_width: Height and width must be specified in increments of 64

application/json

Schema

Schema

any

default

Default

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...