> ## Documentation Index
> Fetch the complete documentation index at: https://gccai.heqingsong.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Query Task

> Query the execution status, progress, and generated results of Flow Music asynchronous tasks

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url https://gccai.heqingsong.uk/v1/music/tasks/task_01K8AYYM6R03TGZ3Q2P0TZVNPX?language=en \
    --header 'Authorization: Bearer <token>'
  ```

  ```python Python theme={null}
  import requests

  task_id = "task_01K8AYYM6R03TGZ3Q2P0TZVNPX"
  url = f"https://gccai.heqingsong.uk/v1/music/tasks/{task_id}"

  headers = {
      "Authorization": "Bearer <token>"
  }

  params = {
      "language": "en"
  }

  response = requests.get(url, headers=headers, params=params)

  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const taskId = "task_01K8AYYM6R03TGZ3Q2P0TZVNPX";
  const url = `https://gccai.heqingsong.uk/v1/music/tasks/${taskId}?language=en`;

  const headers = {
    "Authorization": "Bearer <token>"
  };

  fetch(url, {
    method: "GET",
    headers: headers
  })
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error("Error:", error));
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "code": 200,
    "data": {
      "id": "task_01K8AYYM6R03TGZ3Q2P0TZVNPX",
      "status": "completed",
      "progress": 100,
      "created": 1783413241,
      "completed": 1783413352,
      "actual_time": 111,
      "cost": 0.06,
      "credits_cost": 0.6,
      "result": {
        "music": [
          {
            "clip_id": "a41aade4-993e-4d28-b56f-d97e7ef7167c",
            "title": "My Song",
            "duration_seconds": "181.70666667",
            "audio_url": "https://gccai.heqingsong.uk/_gccai/cdn/audio/flowmusic_a41aade4.m4a",
            "wav_url": "https://gccai.heqingsong.uk/_gccai/cdn/audio/flowmusic_a41aade4.wav"
          }
        ]
      }
    }
  }
  ```

  ```json 404 theme={null}
  {
    "error": {
      "message": "task not found",
      "type": "invalid_request",
      "param": "task_id",
      "code": "task_not_found"
    }
  }
  ```

  ```json 429 theme={null}
  {
    "error": {
      "message": "Current group capacity is saturated, please retry later",
      "type": "rate_limit_error",
      "param": "",
      "code": "rate_limit_error"
    }
  }
  ```
</ResponseExample>

## Authentication

<ParamField header="Authorization" type="string" required>
  All Flow Music endpoints require Bearer Token authentication

  Get your API Key:

  Visit the [API Key Management Page](https://gccai.heqingsong.uk/keys) to get your API Key

  Add it to the request header:

  ```
  Authorization: Bearer YOUR_API_KEY
  ```
</ParamField>

## Path Parameters

<ParamField path="task_id" type="string" required>
  The task ID returned after submitting a Flow Music task

  <Note>
    The task ID comes from `data[0].task_id` in the submission response.
  </Note>
</ParamField>

## Query Parameters

<ParamField query="language" type="string" default="zh">
  Language for error messages and some prompt texts

  Allowed values: `zh`, `en`, `ja`, `ko`
</ParamField>

## Response Fields

<ResponseField name="code" type="integer">
  Response status code, 200 on success
</ResponseField>

<ResponseField name="data" type="object">
  Task details

  <Expandable title="Task fields">
    <ResponseField name="id" type="string">
      Task ID
    </ResponseField>

    <ResponseField name="status" type="string">
      Task status: `pending`, `processing`, `completed`, `failed`
    </ResponseField>

    <ResponseField name="progress" type="integer">
      Task progress, range 0-100
    </ResponseField>

    <ResponseField name="cost" type="number">
      Actual amount charged; usually 0 when the task fails
    </ResponseField>

    <ResponseField name="credits_cost" type="number">
      Credits actually consumed
    </ResponseField>

    <ResponseField name="result" type="object">
      Generated results after the task completes; the fields returned differ by Flow Music capability
    </ResponseField>
  </Expandable>
</ResponseField>

## Result Structure

### Music Tasks

Music generation, extension, section replacement, cover rearrangement, stem separation, audio upload, audio download, and video rendering usually return a `result.music` array.

```json theme={null}
{
  "result": {
    "music": [
      {
        "clip_id": "a41aade4-993e-4d28-b56f-d97e7ef7167c",
        "audio_url": "https://gccai.heqingsong.uk/_gccai/cdn/audio/flowmusic_a41aade4.m4a",
        "wav_url": "https://gccai.heqingsong.uk/_gccai/cdn/audio/flowmusic_a41aade4.wav",
        "video_url": "https://gccai.heqingsong.uk/_gccai/cdn/video/flowmusic_a41aade4.mp4",
        "file_url": "https://gccai.heqingsong.uk/_gccai/cdn/audio/flowmusic_a41aade4_stems.zip"
      }
    ]
  }
}
```

### Lyrics Tasks

Lyrics generation returns a `result.lyrics` array.

```json theme={null}
{
  "result": {
    "lyrics": [
      {
        "title": "Bleached",
        "lyrics": "[Intro]\n(Check)\n(One two)\n..."
      }
    ]
  }
}
```

## Usage Notes

<Note>
  All Flow Music submission endpoints are asynchronous tasks. After a successful submission, first obtain the `task_id`, then call this endpoint to poll the task status; when `status` is `completed`, read the generated results from `result`.
</Note>