Content & ServicesDeveloper Platform
List Device Tasks
Quick Guide
Prerequisites
- Make sure you have retrieved and saved your API key in the Dot. App;
- Make sure you own at least one device and have obtained its device serial number;
The API rate limit is 10 requests per second. With the API, you can control device behavior and responses more flexibly.
Placeholders wrapped in ‘{{variable}}’ indicate values you must replace. Fill them with your actual values and remove the ‘{{}}’ braces.
Request Examples
GET
/api/authV2/open/device/:deviceId/:taskType/listGenerated Code
1curl --request GET \
2 --url https://dot.mindreset.tech/api/authV2/open/device/{{DEVICEID}}/{{TASKTYPE}}/list \
3 --header 'Authorization: Bearer {{API_KEY}}' \
4 --header 'Content-Type: application/json'Response Example
[
{
"type": "TEXT_API",
"key": "text_task_1",
"refreshNow": true,
"title": "Hello",
"message": "World"
},
{
"type": "IMAGE_API",
"key": "image_task_1",
"refreshNow": true,
"border": 0,
"ditherType": "DIFFUSION",
"ditherKernel": "FLOYD_STEINBERG"
}
]Troubleshooting
Endpoint
/api/authV2/open/device/:deviceId/:taskType/list
Method
GET
Path Parameters
Prop
Type
Device serial number
Task type (currently only loop is available)
Request Schema
This interface does not require a request body, only an API key in the request header.
deviceId: device serial numbertaskType: task type, currently onlyloopis available
Response Schema
The response is an array of tasks.
type: content type (onlyTEXT_API/IMAGE_APIare returned)key: task identifier (can benull)- Other fields: the task input payload (varies by task type)
Prop
Type
Task array
Array Items
Content type
Task identifier (used as taskKey for Text/Image API)
Show immediately (may exist)
Title (Text API may exist)
Message (Text API may exist)
Signature (Text API may exist)
Icon (Text API may exist)
NFC redirect link (may exist)
Image data (Image API may exist)
Border color (Image API may exist)
Dither type (Image API may exist)
Dither algorithm (Image API may exist)
Status Codes
| code | Meaning | Description |
|---|---|---|
200 | Success | Successfully retrieved task list |
401 | Unauthorized | Invalid or expired API key |
500 | Server Error | Internal server error |
Did this solve your problem?
Join our community