Skip to main content

v1/jobs/workflow

POST 

/v1/jobs/workflow

create workflow job

Request

Body

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

Responses

OK

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
Loading...