/api/sd/interrogate

POST /api/sd/interrogate

Interrogate tasks will generate a description for an input image.

Header Parameters

Authorization string required
- Bearer DAN_API_KEY.
- Public anonymous DAN_API_KEY is:
sk-000000000000000000000000000000000000000000000000
- Please refer to the Authentication section on how to obtain a private DAN_API_KEY.
Example: Bearer sk-000000000000000000000000000000000000000000000000
Content-Type string required
application/json is required
Example: application/json
Accept string
Example: application/json

application/json

Request Body

image string required
The base64-encoded string of your input image
model string required
The model name used to describe the image, avalaible options are clip and deepdanbooru

Responses

The input image's description is returned here.

application/json

Schema
Example (from schema)
Success

Schema

code integer required
data object required
caption string required
The input image description
taskId string required
queuePosition integer required
The length of the queue of pending tasks, when status != 0, queuePosition = 0
status integer required
0:pending, 1:processing, 2:success, 3:fail
message string required

{
  "code": 0,
  "data": {
    "caption": "string",
    "taskId": "string",
    "queuePosition": 0,
    "status": 0
  },
  "message": "string"
}

Success

{
  "code": 200,
  "data": {
    "taskId": "faa37545-b284-461d-85fc-32468c7af036",
    "queuePosition": 0,
    "status": 2,
    "caption": "a blurry image of a white and blue background with a blurry effect of a blue and white background, Carlos Trillo Name, behance hd, a detailed matte painting, net art"
  },
  "message": "success"
}