Task Sync Endpoint Usage Guide

Endpoint

GET /task/{task_id}

Authentication: Required (API Key in header: Authorization: Bearer <API_KEY>)

Description

This endpoint allows you to fetch the latest, unified result of any task in the system by its task_id. It supports all platforms (Kling, Suno, Luma, Pika, Replicate, RunwayML, Seedance, Hailuo, Veo3, FalAI, MJVideo, Midjourney, etc.).

The response is normalized, making it easy for clients to parse and display results regardless of the underlying platform.

Request Example

GET /task/777935781150867525
Authorization: Bearer sk-xxxxxxx

Response Structure

{
  "task_id": "string",           // The unique ID of the task
  "status": "string",            // Task status: SUCCESS | FAILURE | ...
  "progress": "string",          // Progress percentage (e.g. "100%")
  "err_reason": "string",        // Error reason if status is FAILURE (may be empty)
  "submit_time": number,          // Unix timestamp when the task was submitted
  "finish_time": number,          // Unix timestamp when the task finished
  "message": "string",           // Human-readable message (includes platform, action, etc.)
  "task_result": {                // Main result data, see below for details
    "videos": [                   // (optional) List of video results
      {
        "url": "string",        // Direct link to the video file
        "duration": "string|number", // (optional) Duration in seconds
        "content_type": "string" // (optional) MIME type, e.g. "video/mp4"
      }
    ],
    "images": [                   // (optional) List of image results
      {
        "url": "string",        // Direct link to the image file
        "content_type": "string" // (optional) MIME type, e.g. "image/png"
      }
    ],
    "audio": [                    // (optional) List of audio results
      {
        "url": "string",        // Direct link to the audio file
        "duration": "string|number", // (optional) Duration in seconds
        "content_type": "string" // (optional) MIME type, e.g. "audio/mpeg"
      }
    ],
    "text": "string"             // (optional) Text result, e.g. lyrics or error message
  }
}

Notes

If the task is not found in the main task table, the system will automatically look up in the Midjourney table.

The response is always normalized for easy client-side handling.

If status is FAILURE, the field err_reason will always be present (may be empty).

The task_result object will only contain relevant fields for the platform and task type.

Example Error Response

{
  "error": "Task not found"
}

Task Sync Endpoint Usage Guide

Endpoint#

Description#

Request Example#

Response Structure#