MaxAPI Docs

Submit Action Task(All associated button actions UPSCALE; VARIATION; REROLL; ZOOM, etc.)

Developing

Main URLs

https://api.maxapi.ai

POST

/mj-relax/mj/submit/action

hint:
Switch modes by modifying request uri, for example:

Request

Header Params

Authorization

string

optional

Example:

Bearer sk-V3ESFCWr3ZLemf878bC71eCcF36c483a8f448a02487dAdC7

Body Params application/json

customId

string

required

action identifier

Example:

MJ::JOB::upsample::3::67205abe-ad76-4055-b496-b958970f92f2

taskId

string

required

Task ID

Example:

1710761946823501

notifyHook

string

optional

Callback address, use global notifyHook when empty

state

string

optional

Custom parameters

Example

{
    "customId": "MJ::JOB::upsample::3::67205abe-ad76-4055-b496-b958970f92f2",
    "taskId": "1710761946823501",
    "notifyHook": "string",
    "state": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.maxapi.ai/mj-relax/mj/submit/action' \
--header 'Authorization: Bearer sk-V3ESFCWr3ZLemf878bC71eCcF36c483a8f448a02487dAdC7' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customId": "MJ::JOB::upsample::3::67205abe-ad76-4055-b496-b958970f92f2",
    "taskId": "1710761946823501",
    "notifyHook": "string",
    "state": "string"
}'

Responses

🟢200成功

application/json

Body

code

string

required

Status code: 1 (submission successful), 21 (existing), 22 (queuing), other (error)

Example:

description

string

required

describe

Example:

Submitted successfully

properties

string

optional

extended field

result

string

optional

Task ID

Example:

1320098173412546

Example

{
    "code": "1",
    "description": "Submitted successfully",
    "properties": "string",
    "result": "1320098173412546"
}

Modified at 2024-07-24 18:10:31

Submit Imagine Task

Submit Blend Task