Skip to main content
Kieai logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 38
  • Triggers: 0
  • Slug: KIEAI
  • Version: 20261101_00

Tools

Slug: KIEAI_ADD_INSTRUMENTALAdd 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.

Input Parameters

string
required
Music styles/tags to include in the generated instrumental. Comma-separated list of music genres or characteristics.
string
AI model version to use. Options: V4_5PLUS, V5, V5_5. Default: V4_5PLUS
string
required
Title of the generated music/instrumental.
string
required
URL of the audio file to add accompaniment to. Must be a publicly accessible MP3 or audio file URL.
number
Relative weight of audio elements (0-1, 2 decimals). Controls how much the original audio influences the output.
string
required
URL for receiving task completion updates via webhook.
number
Style adherence strength (0-1, 2 decimals). Higher values make the output closer to the specified style.
string
Vocal preference for the instrumental generation. Use ‘m’ for male or ‘f’ for female.
string
required
Music styles/characteristics to exclude from the generated instrumental.
number
Creative deviation level (0-1, 2 decimals). Higher values produce more creative/unusual results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_ADD_VOCALSAdd 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.

Input Parameters

string ("V4_5PLUS" | "V5" | "V5_5")
Available AI model versions for vocal generation.
string
required
Music style (e.g., jazz, electronic, classical, pop)
string
required
Music title displayed in player interface and file name
string
required
Prompt for generating audio; describes audio content and guides vocal singing style
string
required
URL of the uploaded audio file to add vocals to
number
Relative weight of audio elements (0-1)
string
required
URL for receiving task completion updates
number
Adherence strength to specified style (0-1, 2 decimal places)
string ("m" | "f")
Voice gender preference for vocals.
string
required
Excluded music styles to avoid in generated music
number
Creative/experimental deviation level (0-1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_CREATE_CHAT_COMPLETIONGenerate a synchronous GPT 5.2 response from text or image messages. Use this chat-only action for multimodal conversations, optional web search grounding, and configurable reasoning effort. It consumes Kie.ai credits.

Input Parameters

string ("gpt-5-2")
required
Chat model selected in the request URL. GPT 5.2 is the documented and verified model.
array
Optional built-in web search tool declarations for real-time grounding.
array
required
Conversation messages in order, each containing text or image URL parts.
string ("low" | "high")
Supported reasoning effort levels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_CREATE_MARKET_TASKSubmit a Market API task with a model identifier and speech-oriented input requiring text and voice, plus optional voice settings and callback. The action returns task identification fields for tracking.

Input Parameters

object
required
Input parameters for the model. Parameters vary by model type - see model-specific documentation.
string
required
Model identifier in format ‘provider/model-name’. Examples: ‘elevenlabs/text-to-speech-multilingual-v2’, ‘kling/video-generation’, ‘ideogram/image-generation’, ‘wan/video-generation’.
string
Optional URL to receive a callback when the task completes. Must be a valid HTTPS URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_CREATE_MUSIC_VIDEOCreate 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)

Input Parameters

string
Artist/creator name displayed as signature on video cover. Maximum 50 characters
string
required
Unique identifier of the music generation task, returned from Generate Music or Extend Music endpoints
string
required
Unique identifier of the specific audio track to visualize, returned in callback data after music generation completes
string
Website or brand shown as watermark at bottom of video. Maximum 50 characters
string
required
URL to receive task completion updates via POST request with JSON payload containing video file location

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_EXECUTE_GPT_CODEXSubmit a GPT Codex query through the KIE.AI Market API for programming assistance, such as code completion, refactoring, or explaining bugs. Use a single prompt or a multi-turn conversation, with optional reasoning settings and web search or function tool declarations. Web search and function tools cannot be used together in the same request.

Input Parameters

string
required
The input to send to the model. Can be a plain string for a single-turn query, or a list of message objects for multi-turn conversations. Each message requires a role (‘user’, ‘assistant’, ‘system’, ‘developer’, ‘tool’) and content.
string ("gpt-5-codex" | "gpt-5.1-codex" | "gpt-5.2-codex" | "gpt-5.3-codex" | "gpt-5.4-codex")
required
The GPT Codex model to use. Options: gpt-5-codex, gpt-5.1-codex, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4-codex
array
Tools to enable for the model. Can include web_search (’{“type”: “web_search”}’) or function definitions. Web search and function tools are mutually exclusive and cannot be used together in the same request.
boolean
Enable real-time SSE streaming when set to True. When False (default), the full response is returned at once. Streaming returns incremental deltas rather than the complete response.
object
Reasoning configuration for the Codex model.
string
Controls how the model selects tools. Set to ‘auto’ when using function tools. Must not be set when using web_search alone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_EXTEND_MUSICExtend 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.

Input Parameters

string ("V4" | "V4_5" | "V4_5PLUS" | "V4_5ALL" | "V5" | "V5_5")
required
The AI model version to use for music generation.
string
Music style specification (e.g., ‘pop’, ‘rock’, ‘jazz’). Only required when defaultParamFlag is true.
string
Track title for the extended music. Only required when defaultParamFlag is true.
string
Description of the desired extension content. This instructs the AI on what kind of continuation or variation to create. Required when defaultParamFlag is false.
string
required
The unique identifier of the audio track to extend.
string
Custom persona ID for personalized generation style.
number
Start time point in seconds for the extension. Only required when defaultParamFlag is true.
number
Weight given to the original audio’s characteristics. Value between 0 and 1.
string
required
URL to receive task completion notifications. The API will send a callback when the generation is complete.
number
Controls how closely the style should match. Value between 0 and 1.
string ("m" | "f")
Vocal gender options for music generation.
string
Styles or traits to exclude from the generated music.
boolean
required
Controls parameter source. When true, uses default parameters and requires continueAt, style, and title. When false, uses custom parameters provided in the request.
number
Controls creative randomness. Value between 0 and 1, where 0 is conventional and 1 is highly experimental.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_EXTEND_VEO_VIDEOExtend 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.

Input Parameters

string ("fast" | "quality")
Generation mode for the video extension. ‘fast’ provides quicker generation, ‘quality’ provides higher quality but slower generation.
integer
Random seed for reproducible generation. If not specified, a random seed will be assigned. Range: 10000-99999.
string
required
Text prompt describing the extended video content. Include detailed descriptions of how the video should continue.
string
required
Task ID of the original video generation task to extend. Must be a video generated through the Veo3.1 API.
string
Optional watermark text to add to the generated video extension.
string
Optional HTTPS URL to receive a POST callback when the video extension completes. Must accept JSON payloads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GENERATE_ALEPH_VIDEOSubmit a Runway Aleph video-to-video transformation using a text prompt and reference video URL, optionally with a reference image. The asynchronous task returns an ID for status polling; generated videos are available for 14 days.

Input Parameters

integer
Random seed for reproducible generation. If not specified, a random seed will be used. Using the same seed with identical parameters may produce similar results.
string
required
Descriptive text prompt guiding the AI video generation. Include specific details about the subject, action, style, lighting, camera movement, and setting for best results.
boolean
Upload method for the generated video. Set to true to upload to Alibaba Cloud OSS (for China region), or false for overseas R2 storage.
string
Reference video URL for video-to-video generation. The Aleph model will use this as the base and apply the prompt’s style and modifications.
string
Optional watermark text to add to the generated video. If empty or not provided, no watermark is added.
string ("16:9" | "9:16" | "4:3" | "3:4" | "1:1" | "21:9")
Video aspect ratio for Aleph generation.
string
Optional HTTPS URL to receive a POST callback when the video generation completes. The callback payload includes video URLs and task information.
string
Reference image URL to influence the output style, content, or composition. The generated video will incorporate elements from both the reference image and the prompt.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GENERATE_COVERGenerate 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.

Input Parameters

string
required
The original music task ID returned by the music generation interface. This identifies the source song to create a cover from.
string
required
A valid URL to receive completion notifications via POST request when the cover generation is finished. Must be accessible and able to receive POST requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GENERATE_FLUX_KONTEXT_IMAGEGenerate 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.

Input Parameters

string ("flux-kontext-pro" | "flux-kontext-max")
Available Flux Kontext models.
string
required
Text description for image generation or editing. English language prompts are recommended for best results. Supports text-to-image generation and image editing modes.
string
Optional watermark identifier to embed in the generated image. The watermark will be visible in the output if provided.
string
URL of an existing image to use as a reference for editing mode. When provided, the model will edit the input image rather than generating from scratch. Leave empty for text-to-image generation.
string ("21:9" | "16:9" | "4:3" | "1:1" | "3:4" | "9:16")
Supported aspect ratios for image generation.
string
Optional URL to receive a callback notification when the generation task is complete. The callback will be sent as a POST request with the task result.
string ("jpeg" | "png")
Supported output formats for generated images.
integer
Moderation tolerance level from 0 (strictest) to 6 (most permissive). Lower values filter more content, higher values allow more creative freedom. Defaults to 2.
boolean
Whether to automatically translate non-English prompts to English. Set to false if your prompt is already in English to avoid unnecessary translation. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GENERATE_GPT4O_IMAGEGenerate 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.

Input Parameters

string ("1:1" | "3:2" | "2:3")
required
Aspect ratio of the output image. Supported values: 1:1 (square, good for social media/avatars), 3:2 (landscape, good for photos/banners), 2:3 (portrait, good for mobile wallpapers/posters).
string
required
Text description for the image to generate. Be specific and detailed for best results. English language prompts are recommended.
string
URL of a mask image for partial editing. Black areas in the mask will be edited; white areas remain unchanged. Only used when filesUrl is also provided.
array
List of input image URLs for editing mode (max 5 images). When provided, the model will edit these images rather than generating from scratch. Leave empty for text-to-image generation.
boolean
Whether to enable automatic prompt enhancement. When true, the API will improve and expand your prompt for better results. Defaults to false.
integer
Number of image variants to generate. Valid values: 1, 2, or 4. Each variant will have a slightly different interpretation of the prompt.
string
Optional webhook URL to receive a POST callback when the generation task is complete. The callback will contain the task result with image URLs.
string ("FLUX_MAX" | "GPT_IMAGE_1")
Fallback model options when primary model is unavailable.
boolean
Whether to enable automatic fallback to an alternative model if the primary model is unavailable. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GENERATE_LYRICSSubmit an AI song lyrics generation task from a prompt. A callback URL is required for completion notifications, and the response can contain a task ID for tracking progress.

Input Parameters

string
required
Description of desired lyrics content. Maximum 200 characters. Specific themes, moods, styles, or story elements yield better results.
string
required
A valid URL to receive completion notifications via POST request when the lyrics generation is finished. Must be accessible and able to receive POST requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GENERATE_MIDIGenerate 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.

Input Parameters

string
required
Task ID from completed vocal separation. This is a required field that identifies the separated audio task.
string
Specifies which separated audio track to generate MIDI from. If not provided, generates from all tracks.
string
required
URL to receive MIDI generation completion notifications. This is a required field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GENERATE_MUSICSubmit a legacy Suno music-generation task, send status and results to the required callback URL, and return a task ID for polling. This action consumes Kie.ai credits.

Input Parameters

string ("V4" | "V4_5" | "V4_5PLUS" | "V4_5ALL" | "V5" | "V5_5" | "V6" | "V6_MINI" | "V6_WILD")
required
Suno model version. V4 through V5_5 are discontinued but remain part of the legacy contract.
string
Music style specification. V4 allows 200 characters; later models allow 1000.
string
Track title, available only in custom mode (maximum 80 characters).
string
Lyrics content. In custom mode this takes priority over prompt; V6 models allow up to 5000 characters.
string
Audio idea in non-custom mode (maximum 3000 characters), or fallback lyrics in custom mode.
integer
Custom-mode result diversity from 0 (off) to 4 (maximum). The provider defaults to 1.
number
Custom-mode duration in seconds (10-360); supported by V5_5 and V6 models.
array
Audio references for non-custom generation; each must be 6-1800 seconds and at most 500 MB.
array
Image references for non-custom generation, up to five jpeg, png, webp, or bmp files of at most 10 MB each.
string
Persona ID or Voice ID to apply to generation.
array
One optional mp4, mov, or webm reference for non-custom generation, at most 100 MB and 241 seconds.
boolean
required
Whether to enable detailed controls. Custom mode requires at least one of style, lyrics, or negative_tags. Non-custom mode requires at least one of image_urls, video_urls, audio_urls, style, or lyrics.
number
Custom-mode audio-feature weight from 0 to 1, in increments of 0.01.
boolean
required
Whether to generate instrumental music without vocals.
number
Custom-mode style adherence from 0 to 1, in increments of 0.01.
string ("m" | "f")
Preferred vocal gender.
string
required
URI that receives provider POST callbacks with music generation status and results.
string
Styles or traits to exclude in custom mode (maximum 1000 characters).
string ("style_persona" | "voice_persona")
Ways a persona can guide generation.
number
Custom-mode creative deviation from 0 to 1, in increments of 0.01.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GENERATE_MUSIC_STYLEBoost 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.

Input Parameters

string
required
Style description for music generation. Concise description of the desired music style. Example: ‘Pop, Mysterious’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GENERATE_SOUNDSGenerate 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.

Input Parameters

string ("V5" | "V5_5")
Available models for sound generation.
string
required
Text description of the sound to generate. Limited to 500 characters.
string
Musical key for the sound (e.g., ‘Cm’, ‘D#m’, ‘Any’).
boolean
Whether the generated sound should loop seamlessly. Defaults to false.
boolean
Whether to capture lyrics subtitles from the generated sound. Defaults to false.
integer
BPM (beats per minute) for the sound. Must be between 1 and 300.
string
Callback URL to receive task completion notifications when the generation is finished.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GENERATE_TIMESTAMPED_LYRICSRetrieve 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.

Input Parameters

string
required
Unique identifier of the music generation task, returned from ‘Generate Music’ or ‘Extend Music’ endpoints.
string
required
Unique identifier of the specific audio track for which to retrieve lyrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GENERATE_VEO_VIDEOGenerate 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.

Input Parameters

string ("veo3" | "veo3_fast")
Veo model to use for generation. ‘veo3’ provides higher quality but slower generation. ‘veo3_fast’ generates faster with slightly reduced quality.
integer
Random seed for reproducible generation. If not specified, a random seed will be assigned. Range: 10000-99999.
string
required
Text prompt describing the desired video content. Include detailed descriptions of the scene, actions, camera movements, and visual style for best results.
array
List of image URLs (1-2 images) for image-to-video mode. Required when generationType is ‘FIRST_AND_LAST_FRAMES_2_VIDEO’ or ‘REFERENCE_2_VIDEO’. Images must be publicly accessible.
string
Optional watermark text to add to the generated video.
string ("16:9" | "9:16" | "Auto")
Video aspect ratio. ‘16:9’ for landscape, ‘9:16’ for portrait, ‘Auto’ for automatic detection based on content.
string
Optional HTTPS URL to receive a POST callback when the video generation completes. Must accept JSON payloads.
string ("TEXT_2_VIDEO" | "FIRST_AND_LAST_FRAMES_2_VIDEO" | "REFERENCE_2_VIDEO")
Video generation mode.
boolean
Whether to automatically translate the prompt to English. Defaults to true for optimal results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_ACCOUNT_CREDITSRetrieve 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_ALEPH_VIDEO_DETAILSRetrieves 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).

Input Parameters

string
required
Unique task identifier for the Aleph video generation task. Obtain this from the response when creating a video generation task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_COVER_DETAILSGet 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).

Input Parameters

string
required
The cover generation task ID to retrieve status and details for. This is returned when a cover generation task is initiated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_FLUX_KONTEXT_IMAGE_DETAILSRetrieve 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

Input Parameters

string
required
The unique task identifier returned from the Flux Kontext image generation endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_GPT4O_IMAGE_DETAILSRetrieves 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.

Input Parameters

string
required
Unique task identifier for the image generation task. Obtain this from the response when creating an image generation task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_LYRICS_DETAILSRetrieves 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.

Input Parameters

string
required
Unique identifier of the lyrics generation task. This ID is returned when creating a lyrics generation task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_MARKET_TASK_DETAILSRetrieves 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.

Input Parameters

string
required
The unique identifier of the task to query. This ID is returned when a task is created via the Market API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_MIDI_DETAILSRetrieves 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.

Input Parameters

string
required
Task ID returned from the MIDI generation request. This is a required field to identify the MIDI generation task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_MUSIC_DETAILSGet 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.

Input Parameters

string
required
Unique identifier of the music generation task to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_MUSIC_VIDEO_DETAILSRetrieves 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.

Input Parameters

string
required
Unique task identifier for the music video generation task. Obtain this from the response when creating a music video generation task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_RUNWAY_VIDEO_DETAILSRetrieves 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.

Input Parameters

string
required
Unique task identifier for the video generation or extension task. Obtain this from the response when creating a video generation task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_TIMESTAMPED_LYRICS_STATUSRetrieve timestamped lyrics for a specific audio track from a music generation task, including word-level timing for synchronization.

Input Parameters

string
required
Unique identifier of the music generation task, returned from ‘Generate Music’ or ‘Extend Music’ endpoints.
string
required
Unique identifier of the specific audio track for which to retrieve lyrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_VEO1080P_VIDEORetrieve 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.

Input Parameters

integer
Zero-based index of the video to retrieve in 1080p. Use when the generation produced multiple videos. Defaults to 0 if not specified.
string
required
Unique task identifier for the video generation task. Obtain this from the response when creating a video generation task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_VEO4K_VIDEORetrieve 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.

Input Parameters

integer
Zero-based index of the video to retrieve in 4K. Use when the generation produced multiple videos. Defaults to 0 if not specified.
string
required
Unique task identifier for the video generation task. Obtain this from the response when creating a video generation task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_VEO_VIDEO_DETAILSRetrieves 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.

Input Parameters

string
required
Unique task identifier for the video generation task. Obtain this from the response when creating a video generation task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_GET_WAV_DETAILSRetrieves 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.

Input Parameters

string
required
Unique identifier of the WAV conversion task. Obtain this from the response when initiating a WAV conversion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_REGISTER_OMNI_VOICE_PRESETRegister a Gemini Omni preset voice and return its reusable audio ID.

Input Parameters

string
required
Name for the registered voice. Maximum 210 characters.
string ("achernar" | "achird" | "algenib" | "algieba" | "alnilam" | "aoede" | "autonoe" | "callirrhoe" | "charon" | "despina" | "enceladus" | "erinome" | "fenrir" | "gacrux" | "iapetus" | "kore" | "laomedeia" | "leda" | "orus" | "puck" | "pulcherrima" | "rasalgethi" | "sadachbia" | "sadaltager" | "schedar" | "sulafat" | "umbriel" | "vindemiatrix" | "zephyr" | "zubenelgenubi")
required
Provider preset voice ID to register.
string
Example dialogue for the voice. Maximum 120 characters.
string
Voice timbre, style, speaking rate, emotion, and other traits. Maximum 20000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_REPLACE_MUSIC_SECTIONReplace 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.

Input Parameters

string
required
Music style tags to apply to the replacement (e.g., jazz, electronic, pop, rock).
string
required
Music title for the modified track.
string
required
Prompt for generating the replacement segment. Describes the desired content for the new section.
string
required
Original task ID (parent task) to identify the source music. This is the task ID returned when the original track was generated.
string
required
Unique audio track identifier to replace. This is the specific audio ID of the track you want to modify.
string
Complete lyrics for the entire track after modification. Use this if you want to update the lyrics along with the section replacement.
number
required
End time in seconds for the replacement section. Must be greater than infillStartS. The replacement duration should be between 6 and 60 seconds.
string
Callback URL for receiving task completion notifications. The API will send a webhook when the generation is complete.
number
required
Start time in seconds for the replacement section. Must be less than infillEndS and at least 0.
string
Music styles to exclude from the replacement (e.g., Rock, Metal).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KIEAI_SEPARATE_VOCALSSeparates 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.

Input Parameters

string ("separate_vocal" | "split_stem")
Type of separation mode. Use ‘separate_vocal’ for 2 stems (vocal + instrumental) at 10 credits, or ‘split_stem’ for up to 12 stems (vocals, backing vocals, drums, bass, guitar, keyboard, strings, brass, woodwinds, percussion, synth, FX) at 50 credits.
string
required
ID of the original music generation task. This identifies the parent task that generated the audio.
string
required
The specific audio track ID to process for vocal separation.
string
required
URL to receive task completion notifications. The API will send a callback when processing is complete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not