Timestamped Lyrics

Retrieve word-level timestamped lyrics for karaoke-style displays and get exact timing data for your generated music.

Endpoint Overview

POST/api/v1/audio/music/timestamped-lyrics

Send a POST request with the completed music audio ID to get a detailed array of all lyrics, grouped by segment, with start and end times in milliseconds.

Credits: 2 credits per request.

Parameters

Paramètre	Type	Requis	Description
`task_id`	string	Requis	The task ID that generated the music (usually returned by POST /api/v1/audio/music).
`audio_id`	string	Requis	The specific audio clip ID (e.g. from the response of the feed API).

Example Request

cURL

bash

curl -X POST "https://apiin.one/api/v1/audio/music/timestamped-lyrics" \
  -H "Authorization: Bearer aio_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "task_id": "gen123abc456def789ksv",
    "audio_id": "song_abc123"
  }'

Example Response

Synchronous response returning the complete timing data.

json

{
  "code": 200,
  "message": "success",
  "data": {
    "text": "[Verse 1]\nIt's a beautiful day...",
    "lyricParams": [
      {
        "text": "[Verse 1]\n",
        "metadata": {
          "style": "Verse 1"
        },
        "type": "segment_break"
      },
      {
        "text": "It's a beautiful day",
        "start": 11.23,
        "end": 14.89,
        "type": "lyric"
      }
    ],
    "waveform": [
      0.2,
      0.4,
      0.5
    ]
  }
}

Error Handling

Status Code	Type	Requis	Description
`400`	bad_request	Optionnel	Missing task_id or audio_id.
`401`	authentication_error	Optionnel	Invalid or missing API key.
`404`	not_found	Optionnel	Audio or lyrics not found.