Kieai

Add AI-generated instrumental accompaniment to an existing vocal track. Use when you need to generate instrumental music to accompany a vocal recording, allowing customization of style, mood, and creative parameters. The task completion will be notified via the callback URL.

Add AI-generated vocals to an existing instrumental music track. Use this action when you want to add singing or vocal tracks to accompany an existing instrumental audio file. The action submits a vocal generation task and returns a task ID that can be used to track the generation status. This action is asynchronous - use the returned taskId to poll for completion via the callback URL or check task status separately.

Create a task for unified model access through the Market API. Submit tasks to any supported AI model (Kling, Sora2, Hailuo, Wan, Google, Ideogram, ElevenLabs, etc.) through a single unified interface. Specify the model and its input parameters, then receive a task ID to poll for completion. Use this action when you need to generate content (text-to-speech, images, video, etc.) via Kie.ai's unified Market API with access to multiple AI providers through one endpoint.

Create a music video (MP4) combining generated music with visuals. Use this action when you need to generate an MP4 music video from previously generated music tracks. The action requires a task ID from the music generation process and an audio ID for the specific track. The video generation is async - results are delivered to the specified callback URL. Once the video is ready, the callback URL receives a POST request with: - code: 0 for success, 500 for error - data.task_id: The unique task identifier - data.video_url: The video URL (valid for 14 days)

Access GPT Codex capabilities through the KIE.AI Market API. Use when you need to leverage advanced code understanding and generation abilities via the Codex model for tasks such as code completion, refactoring, bug explanation, or general programming assistance. The action supports both single-turn queries (plain string input) and multi-turn conversations (list of message objects with roles). Optional features include configurable reasoning depth, web search for up-to-date information, and function calling for structured tool use. Note: Web search and function tools are mutually exclusive and cannot be used together in the same request. When streaming is enabled (stream=True), the response is delivered incrementally via SSE events.

Extend an existing Suno music track with additional AI-generated content. Use this action when you need to extend or modify existing music by creating a continuation or variation based on the provided audio ID and parameters. The action submits a generation request and returns a task ID that can be used to track the progress via callback. Note: When defaultParamFlag is false, provide custom parameters (prompt, styleWeight, etc.) to control the extension behavior. When defaultParamFlag is true, provide continueAt, style, and title instead.

Extend an existing Veo3.1 video with additional AI-generated content. Continues a previously generated video by adding new frames that seamlessly follow the original video. Use this action when you need to extend a video generated through the Veo3.1 API with additional content. After submission, poll 'Get Veo Video Details' using the returned taskId to check extension status until completion. Note: Video extension is asynchronous. You will receive a taskId in the response that must be used to poll for completion status. Only videos generated through the Veo3.1 API can be extended, and videos generated after 1080P cannot be extended.

Generate AI video using Runway Aleph model from text prompts. Creates high-quality video content based on detailed text descriptions, optionally with reference video or image inputs. Use when you need to generate a video from a text description (text-to-video) or transform an existing video with AI (video-to-video). After submission, poll 'Get Aleph Video Details' using the returned taskId to check generation status until completion. Note: Video generation is asynchronous. You will receive a taskId in the response that must be used to poll for completion status. Generated videos are available for 14 days after completion.

Generate a personalized cover version of a song using AI. Use when you want to create AI-generated variations or custom covers of existing music tracks. Each music task can only generate one Cover. Cover images are typically valid for 14 days. The action returns a task ID that can be used to track the generation progress. The callback URL will receive a POST request when cover generation completes, containing the task ID and generated image URLs.

Generate or edit images using the Flux Kontext model. Supports both text-to-image generation and image editing modes. Use when you need to create new images from text descriptions or edit existing images with AI-powered transformations. The API returns a task ID that can be used to poll for completion status. Generated images expire after 14 days.

Generate images using the GPT-4o image generation model. Creates AI-generated images from text prompts. Use when you need to create new images from text descriptions. The API returns a task ID that should be polled using the 'Get GPT-4o Image Details' action to check completion status and retrieve the generated image URLs. Generated images are stored for 14 days and download URLs are valid for 20 minutes.

Generate creative lyrics using AI. Creates new song lyrics based on the provided prompt, style, and other parameters. Use when you want to create AI-generated song lyrics for a music track or need creative lyrical content. The action returns a task ID that can be used to track the generation progress. When generation completes, the callback URL will receive a POST request with the generated lyrics data including 2-3 lyric variations with titles. Note: Generated lyrics are retained for 14 days.

Generate MIDI file from audio or music generation. Converts audio tracks to MIDI format for use in digital audio workstations. Use when you need to convert separated audio stems (from vocal/instrument separation) into MIDI files for further music production workflows. This action requires a valid taskId from a prior vocal separation operation and a callback URL to receive completion notifications. Prerequisites: Must first use the Vocal & Instrument Stem Separation API to separate audio before generating MIDI.

Boost or enhance music style parameters for improved music generation. Use when you need to generate or enhance music style descriptions to influence AI music generation. The content field should contain a concise description of the desired music style. Returns a task ID that can be used to track the generation progress and credits information for the request.

Generate sound effects or audio clips based on a text description. Creates AI-generated audio sounds with configurable parameters like tempo, key, and looping. Use this action when you need to generate sound effects, short audio clips, or ambient sounds for projects. The action submits a generation request and returns a task ID that can be used to track progress via polling or callback. Supports BPM control (1-300), musical key selection (e.g., Cm, D#m, Any), looping option, and optional lyrics capture. The generated sounds are typically valid for 14 days.

Retrieve synchronized lyrics with timestamps for a music track. Gets lyrics with time markers for karaoke-style synchronization. Use this action when you need to display synchronized lyrics for a generated music track or implement karaoke-style highlighting.

Generate AI video using Google Veo3.1 model from text prompts or images. Creates high-quality video content based on detailed text descriptions or by animating provided images. Use when you need to generate a video from a text description (text-to-video) or animate one or more reference images (image-to-video). After submission, poll 'Get Veo Video Details' using the returned taskId to check generation status until completion. Note: Video generation is asynchronous. You will receive a taskId in the response that must be used to poll for completion status.

Retrieve the current credit balance for your KIE.AI account. Use when you need to check available credits before making API requests or monitor account usage. This action is read-only and does not modify any data.

Retrieves details and status of an Aleph video generation task. Returns task information including current status (generating, success, or failed) and video URLs when complete. Use this action when checking the progress of a video generation task or retrieving the final video output after completion. This is a polling endpoint—call periodically until task completion. Note: Generated videos are only available for 14 days. The resultVideoUrl and resultImageUrl are only present when successFlag is 1 (success).

Get the status and details of a cover song generation task. Use when you need to check the progress of a cover generation task or retrieve the generated cover image URLs after completion. The response includes the task status (pending, generating, success, or failed), creation and completion timestamps, and the generated cover image URLs when the task is complete. Poll this endpoint to track task progress until successFlag indicates completion (1) or failure (3).

Retrieve the status and details of a Flux Kontext image generation task. Use this action when you need to check the progress of an image generation task, get the generated image URL upon completion, or diagnose why a task failed. The task status (successFlag) indicates: - 0 (GENERATING): Task is still processing - 1 (SUCCESS): Task completed with image URL in response field - 2 (CREATE_TASK_FAILED): Task creation failed - 3 (GENERATE_FAILED): Task created but image generation failed

Retrieves details and status of a GPT-4o image generation task. Returns task information including current status (generating, success, or failed) and image URLs when complete. Use when checking the progress of an image generation task or retrieving the final image output after completion. This is a polling endpoint—call periodically until task completion. Note: Image generation tasks return URLs that are available only for a limited time. Download images promptly after task completion.

Retrieves the status and details of a lyrics generation task. Returns the generated lyrics text when the task is complete. Use this action to poll for lyrics generation results after submitting a lyrics generation request. The task status can be: PENDING (waiting), SUCCESS (complete), or various error states. If the status is SUCCESS, check the response.data.response.data field for the generated lyrics.

Retrieves the status and details of a Market API task by its task ID. Use when you need to check the progress or outcome of a previously submitted task, such as after creating a task with a Market API action or when polling for completion. This action queries the unified Market API job status endpoint.

Retrieves details and status of a MIDI generation task. Returns MIDI data including detected instruments, notes, timing, and velocity when the task is complete. Use when checking the progress of a MIDI generation task or retrieving the final MIDI output after completion. This is a polling endpoint—call periodically until task completion. Note: MIDI records are retained for 14 days. When using vocal separation with type 'split_stem', the midiData field may be empty. Check errorCode and errorMessage fields when successFlag indicates failure.

Get the status and details of a Suno music generation task including generated audio URLs and metadata. Use this action when you need to check the completion status of a music generation task, retrieve audio URLs for download or playback, or monitor the progress of a previously submitted generation request. Poll this endpoint until status reaches SUCCESS or an error state. Note that instrumental tracks will not include lyrics data.

Retrieves details and status of a music video generation task. Returns task information including current status (PENDING, SUCCESS, or failed) and video URL when complete. Use when checking the progress of a music video generation task or retrieving the final video output after completion. This is a polling endpoint—call periodically until task completion. Note: Video records are only available within 14 days after generation.

Retrieves details and status of a Runway video generation task. Returns comprehensive task information including the current state (wait, queueing, generating, success, or fail) and video URLs when the task is complete. Use this action when checking the progress of a Runway video generation task or retrieving the final video output after completion. This is a polling endpoint—call periodically until the task reaches a terminal state. Note: Video URLs returned in the response are valid for 14 days. For extension tasks, the parentTaskId field indicates the original generation task.

Retrieve the status and results of a timestamped lyrics generation task. Use this action when you need to check the completion status of a previously initiated timestamped lyrics generation request, or to retrieve the lyrics data with word-level timestamps for karaoke-style synchronization. Note: The data field will be populated once the task completes successfully.

Retrieve the 1080p high-definition version of a completed Veo3.1 video generation. Use when you need to download the HD version of a video after the initial generation is complete. The 1080p conversion typically takes 1-3 minutes after the original generation completes. Note: Poll this endpoint every 20-30 seconds until the video is ready. If the task is still processing, the API will return an appropriate error. The original generation task must be successful before requesting the 1080p version.

Retrieve the 4K ultra-high-definition version of a completed Veo3.1 video generation. Use when you need to download the 4K version of a video after the original generation is complete. The 4K conversion typically takes longer than the 1080p conversion (approximately 2-5 minutes) after the original generation completes. Use this action when you have a completed video generation task and want to access the premium 4K quality output. Poll this endpoint every 30-45 seconds until the video is ready. The original generation task must be successful before requesting the 4K version.

Retrieves details and status of a Veo3.1 video generation task. Returns task information including current status (generating, success, or failed) and video URLs when complete. Use when checking the progress of a video generation task or retrieving the final video output after completion. This is a polling endpoint—call periodically until task completion. Note: Videos generated with fallback model cannot be upgraded to 1080P. Records are only available within 14 days.

Retrieves the status and download URL for a WAV conversion task. Returns task information including current status (PENDING, SUCCESS, or failed) and the WAV audio URL when complete. Use when checking the progress of a WAV conversion task or retrieving the final audio output after completion. This is a polling endpoint—call periodically until task completion. Note: WAV files are retained for 14 days. The audioWavUrl is only available when successFlag is SUCCESS.

Replace a specific section of a Suno music track with new AI-generated content. Use this action when you need to modify a portion of an existing music track by replacing it with newly generated content while preserving the rest of the track. The action submits a replacement request and returns a task ID that can be used to track progress via callback. Constraints: - The replacement duration (infillEndS - infillStartS) must be between 6 and 60 seconds. - The replacement cannot exceed 50% of the original music's total duration. - This action is irreversible once submitted.

Separates vocals and instruments from an audio track using AI-powered audio source separation. Use this action when you need to extract vocals from an instrumental track, create karaoke versions of songs, isolate vocals for remixing, or generate instrumentals for sampling. The action supports two separation modes: 'separate_vocal' (2 stems - vocal and instrumental) and 'split_stem' (up to 12 stems). Results are delivered via callback URL, and audio URLs remain accessible for 14 days. Note: Re-submitting the same track deducts credits again with no caching.