POST /mj/submit/describe

Method: POSTEndpoint: /mj/submit/describe

Callback URL. If empty, the global notifyHook is used.

Request Parameters

Header Parameters

Authorization
string
Optional
Default Value:
Bearer {{YOUR_API_KEY}}

Body Parameters application/json

base64
string
imagebase64
Required
Example:
data:image/png;base64,xxx
notifyHook
string
Optional
Callback URL. If empty, the global notifyHook is used.
Example
{
"base64"
:
"data:image/png;base64,xxx"
,
"notifyHook"
:
"string"
}

Example Request

Shell

curl --location --request POST '/mj/submit/describe' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "base64": "data:image/png;base64,xxx",
    "notifyHook": "string"
}'

Response

🟢 200 OK

Content Type: application/json

Response Schema

code
integer
<int32>
Required
Status Code: 1 (submission succeeded), 21 (already exists), 22 (queued), other (error)
Example:
1
description
string
Description
Required
Example:
submission succeeded
properties
object
Extended Fields
Optional
result
string
Task ID
Optional
Example:
1320098173412546

Example

{
    "code": 1,
    "description": "Submission succeeded",
    "properties": {},
    "result": 1320098173412546
}

🟢 201 Created

🟠 401 Unauthorized

🟠 403 Forbidden

🟠 404 Not Found