PiAPI
HomeWorkspace
HomeWorkspace
Join Discord
  1. Song(Udio)
  • Get Started
    • Overview
    • Quickstart
    • Make Instruction: How to Use PiAPI to Build a Workflow on Make?
  • Endpoints
    • Song(Udio)
      • Song API Task Creation Examples
      • [Udio] Song Extend
      • Get Task
        GET
      • Create Task
        POST
      • [Udio] Generate Lyrics
        POST
    • Kling
      • Lipsync With PiAPI Kling API Examples
      • Motion Brush With PiAPI Kling API Example
      • Kling Elements Video Generation API
      • Kling Effects Video Generation
      • Cancel Task
        • Cancel Tasks
        • Cancel Task
      • Get Task
      • Create Task
      • Kling Virtual Try-On
    • Hailuo
      • Hailuo Director Mode Example
      • Generate Video
      • Get Task
    • Flux
      • Flux with LoRA and Controlnet
      • Available LoRA and Controlnet
      • Flux API with Redux Variation, Fill, Inpaint and Outpaint
      • Create Task
        • Text to Image
        • Image to Image
      • Get task
    • AI Hug
      • Get Task
      • Create Task
    • LLM
      • Use Cases for GPT-4o Image API
      • How To Avoid Timeouts in Completion API
      • GPT-4o Image Generation API
      • LLM API | Basic Completions
      • Get Task
    • Midjourney
      • PiAPI Penalties on Midjourney Usage
      • Detailed Explaination on Midjourney Task Result
      • Midjourney V7 API Instructions
      • Create Task
        • Imagine
        • Upscale
        • Variation
        • Reroll
        • Describe
        • Seed
        • Blend
        • Inpaint
        • Outpaint
        • Pan
      • Cancel Task
        • Cancel Task
        • Cancel Tasks
      • Get Task
    • Faceswap
      • Multi Faceswap
      • Image Faceswap
      • Video Faceswap
      • Get Task
    • TTS
      • Zeroshot Text-to-Speech F5-TTS
      • Get Task
    • Trellis
      • Create Task
      • Get Task
    • Luma Dream Machine
      • Cancel Task
        • Cancel Tasks
        • Cancel Task
      • Create Task
      • Get Task
    • WanX
      • Available LoRA Types for Wanx
      • Generate WanX Task with LoRA Using PiAPI
      • Use Cases for Wanx LoRA
      • Create Task
      • Get Task
    • Skyreels
      • Create Task
      • Get Task
    • Framepack
      • Create Task
      • Get Task
    • Hunyuan Video
      • How to Make a Hunyuan API Call
      • Get Task
      • Generate Video
    • Mmaudio
      • Get Task
      • Generate Audio
    • DiffRhythm
      • Generate Audio
      • Get Task
    • Tools
      • File Upload API
      • Video Upscale
      • Video Upscale-Get Task
      • Remove Background API
      • Remove Background-Get Task
      • Segment With Prompt API
      • Segment With Prompt API-Get Task
      • Image Upscale(Super Resolution) API
      • Image Upscale-Get Task
    • PiAPI Account Management
      • PiAPI Account Info
      • Task List Info
      • User Task History
  • Resources
    • Change Log
    • Output Storage
    • Unified API Schema
    • Webhook
    • Bulk Generation Service
    • Billings
    • PiAPI MCP Server
    • Workspace Manual
      • Host-your-account (HYA) | Back-up Account
      • Host-your-account (HYA) | Debug Checklist
      • Host-your-account (HYA) | Connected Account Status
    • Announcements
      • PiAPI 2025 January 1st Pricing Update
  • Legacy Documentation
    • Midjourney
      • Midjourney Webhook
      • Imagine
      • Reroll
      • Upscale
      • Variation
      • Inpaint
      • Outpaint
      • Pan
      • Describe
      • Blend
      • Seed
      • Fetch
      • Multi Fetch
      • Cancel
    • Face Swap
      • Video Faceswap
      • Multi-face-swap
      • Fetch
    • Dream Machine
      • Video Generation
      • Video Extend
      • Get Video Generation
    • Kling
      • Video Generation
      • Video Extend
      • Get Video Generation
  1. Song(Udio)

[Udio] Generate Lyrics

POST
/api/v1/task
Uses Udio to synthesize lyrics.

Request

Header Params
x-api-key
string 
required
Your API key for authorization
Body Params application/json
model
enum<string> 
required
Allowed value:
music-u
task_type
enum<string> 
required
Allowed value:
generate_lyrics
input
object 
required
prompt
string 
required
The prompt serve as a guidance to assist udio in writing the lyrics.
config
object 
optional
webhook_config
object 
optional
Webhook provides timely task notifications. Check PiAPI webhook for detail.
service_mode
enum<string> 
optional
This allows users to choose whether this specific task will get processed under PAYG or HYA mode. If unspecified, then this task will get processed under whatever mode (PAYG or HYA)
the user chose on the workspace setting of your account.
public means this task will be processed under PAYG mode.
private means this task will be processed under HYA mode.
Allowed values:
publicprivate
Example
{
  "model": "music-u",
  "task_type": "generate_lyrics",
  "input": {
    "prompt": "White egrets fly over the vast paddy fields"
  },
  "config": {
    "webhook_config": {
      "endpoint": "",
      "secret": ""
    },
    "service_mode": ""
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.piapi.ai/api/v1/task' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "music-u",
    "task_type": "generate_lyrics",
    "input": {
        "prompt": "White egrets fly over the vast paddy fields"
    },
    "config": {
        "webhook_config": {
            "endpoint": "",
            "secret": ""
        },
        "service_mode": ""
    }
}'

Responses

🟢200Success
application/json
Body
code
integer 
required
data
object 
required
task_id
string 
required
model
string 
required
task_type
string 
required
status
enum<string> 
required
Hover on the "Completed" option and you coult see the explaintion of all status: completed/processing/pending/failed/staged
Allowed values:
CompletedProcessingPendingFailedStaged
input
object 
required
output
object 
required
meta
object 
required
detail
null 
required
logs
array [object] 
required
error
object 
required
message
string 
required
If you get non-null error message, here are some steps you chould follow:
Check our common error message
Retry for several times
If you have retried for more than 3 times and still not work, file a ticket on Discord and our support will be with you soon.
Example
{
  "code": 200,
  "data": {
    "task_id": "8ec657c9-a2b8-4ea7-824f-4547d108a779",
    "model": "music-u",
    "task_type": "generate_lyrics",
    "status": "pending",
    "config": {
      "service_mode": "public",
      "webhook_config": {
        "endpoint": "",
        "secret": ""
      }
    },
    "input": {},
    "output": {
      "lyrics_pairs": [
        {
          "title": "Winter Wind",
          "text": "[Verse]\nSnowflakes falling skies so dim\nCold breeze whispers light and slim\nFootsteps fade in frozen sand\nEchoes lost in a snowy land\n\n[Verse 2]\nI walk alone through icy streets\nEach step a heart that's lost its beat\nSilent nights so crystal clear\nWinter wind wipes away my tear\n\n[Chorus]\nWinter wind where do you blow\nThrough the pines and through the snow\nChilling hearts and numbing souls\nWinter's tale forever told\n\n[Verse 3]\nNights are long as shadows grow\nBlankets thick with frost so slow\nFires burn in hearths so bright\nChase away the winter's bite\n\n[Bridge]\nBut even in this icy gloom\nStars above still gently bloom\nGuiding me like whispers kind\nIn the heart of the winter wind\n\n[Chorus]\nWinter wind where do you blow\nThrough the pines and through the snow\nChilling hearts and numbing souls\nWinter's tale forever told"
        },
        {
          "title": "Winter Wind",
          "text": "[Verse]\nSnowflakes dance and swirl on high\nSilent whispers from the sky\nFootprints vanish where we tread\nWarmth and shivers in our bed\n\n[Verse 2]\nBreath of frost and cheeks aglow\nTrees like statues in a row\nStars wink through the icy veil\nDreams embark without a sail\n\n[Chorus]\nWinter wind don't let me go\nHold me tight in crystal snow\nEvery chill a sweet embrace\nLife's a wonder in this place\n\n[Verse 3]\nIce skates carve our fleeting flight\nMoonlight paints the world in white\nNorthern lights ignite the night\nFrozen wonder such a sight\n\n[Bridge]\nIn the hush the world stands still\nPeaceful moments winter's thrill\nNature's canvas frost and chill\nEchoes silent hearts they fill\n\n[Chorus]\nWinter wind don't let me go\nHold me tight in crystal snow\nEvery chill a sweet embrace\nLife's a wonder in this place"
        }
      ]
    },
    "meta": {},
    "detail": null,
    "logs": [],
    "error": {
      "code": 0,
      "raw_message": "",
      "message": "",
      "detail": null
    }
  },
  "message": "success"
}
Modified at 2025-04-24 12:16:06
Previous
Create Task
Next
Lipsync With PiAPI Kling API Examples