Task List Query
Paginated query of all async tasks for the current API Key user, with filtering by platform, status, and time.
Paginated query of all async tasks for the current API Key user, with filtering by platform, status, and time.
GET https://apione.org/api/task/self
This interface uses account session or Access Token authentication, suitable for displaying task history in your own backend.
| Parameter | Type | Required | Default | Description |
|---|
p | int | No | 1 | Page number, starting from 1 |
page_size | int | No | 10 | Items per page, max 100 |
| Parameter | Type | Required | Description |
|---|
task_id | string | No | Exact query by task ID |
platform | string | No | Task platform, e.g. suno, mj |
status | string | No | Task status, see table below |
action | string | No | Task type, e.g. MUSIC, LYRICS, generate |
start_timestamp | int64 | No | Start time (Unix seconds), filter by submit time |
end_timestamp | int64 | No | End time (Unix seconds), filter by submit time |
| Value | Meaning |
|---|
NOT_START | Not started |
SUBMITTED | Submitted |
QUEUED | Queued |
IN_PROGRESS | Processing |
SUCCESS | Succeeded |
FAILURE | Failed |
UNKNOWN | Unknown |
curl "https://apione.org/api/task/self?p=1&page_size=20&platform=suno&status=SUCCESS" \
-H "Authorization: <access_token>" \
-H "New-Api-User: <user_id>"
{
"success": true,
"message": "",
"data": {
"page": 1,
"page_size": 20,
"total": 42,
"items": [
{
"id": 1001,
"task_id": "task_abcdef0123456789",
"platform": "suno",
"action": "MUSIC",
"status": "SUCCESS",
"progress": "100%",
"result_url": "https://file1.example.com/file/xxxx.mp3",
"fail_reason": "",
"submit_time": 1717200000,
"start_time": 1717200005,
"finish_time": 1717200060,
"quota": 1000,
"created_at": 1717200000,
"updated_at": 1717200060
}
]
}
}
| Field | Type | Description |
|---|
id | int | Task record ID |
task_id | string | Task ID |
platform | string | Task platform |
action | string | Task type |
status | string | Task status |
progress | string | Progress, e.g. "0%", "100%" |
result_url | string | Result link (returned on success) |
fail_reason | string | Failure reason |
submit_time | int64 | Submit time (Unix seconds) |
start_time | int64 | Start time (Unix seconds) |
finish_time | int64 | Finish time (Unix seconds) |
quota | int | Quota consumed |
created_at | int64 | Creation time (Unix seconds) |
updated_at | int64 | Update time (Unix seconds) |