Kieai

kieai

AI API platform providing video generation (Veo3, Kling, Runway, Luma), image generation (Flux, Nano Banana), music creation (Suno), and LLM capabilities with pay-as-you-go pricing

Artificial Intelligence Developer Tools AI Content Generation Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (35)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Instrumental to Vocal TrackKIEAI_ADD_INSTRUMENTALAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add vocals to instrumentalKIEAI_ADD_VOCALSAcción

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.

Parámetros de entrada

modelstringenum
Available AI model versions for vocal generation.
V4_5PLUSV5V5_5
stylestringObligatorio
Music style (e.g., jazz, electronic, classical, pop)
titlestringObligatorio
Music title displayed in player interface and file name
promptstringObligatorio
Prompt for generating audio; describes audio content and guides vocal singing style
upload_urlstringObligatorio
URL of the uploaded audio file to add vocals to
audio_weightnumber
Relative weight of audio elements (0-1)
callback_urlstringObligatorio
URL for receiving task completion updates
style_weightnumber
Adherence strength to specified style (0-1, 2 decimal places)
vocal_genderstringenum
Voice gender preference for vocals.
mf
negative_tagsstringObligatorio
Excluded music styles to avoid in generated music
weirdness_constraintnumber
Creative/experimental deviation level (0-1)

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Market TaskKIEAI_CREATE_MARKET_TASKAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create music video from generated audioKIEAI_CREATE_MUSIC_VIDEOAcción

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)

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Execute GPT CodexKIEAI_EXECUTE_GPT_CODEXAcción

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.

Parámetros de entrada

inputanyObligatorio
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.
modelstringObligatorioenum
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
gpt-5-codexgpt-5.1-codexgpt-5.2-codexgpt-5.3-codexgpt-5.4-codex
toolsarray
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.
streamboolean
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.
reasoningobject
Reasoning configuration for the Codex model.
tool_choicestring
Controls how the model selects tools. Set to 'auto' when using function tools. Must not be set when using web_search alone.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Extend Suno MusicKIEAI_EXTEND_MUSICAcción

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.

Parámetros de entrada

modelstringObligatorioenum
The AI model version to use for music generation.
V4V4_5V4_5PLUSV4_5ALLV5V5_5
stylestring
Music style specification (e.g., 'pop', 'rock', 'jazz'). Only required when defaultParamFlag is true.
titlestring
Track title for the extended music. Only required when defaultParamFlag is true.
promptstring
Description of the desired extension content. This instructs the AI on what kind of continuation or variation to create. Required when defaultParamFlag is false.
audioIdstringObligatorio
The unique identifier of the audio track to extend.
personaIdstring
Custom persona ID for personalized generation style.
continueAtnumber
Start time point in seconds for the extension. Only required when defaultParamFlag is true.
audioWeightnumber
Weight given to the original audio's characteristics. Value between 0 and 1.
callBackUrlstringObligatorio
URL to receive task completion notifications. The API will send a callback when the generation is complete.
styleWeightnumber
Controls how closely the style should match. Value between 0 and 1.
vocalGenderstringenum
Vocal gender options for music generation.
mf
negativeTagsstring
Styles or traits to exclude from the generated music.
defaultParamFlagbooleanObligatorio
Controls parameter source. When true, uses default parameters and requires continueAt, style, and title. When false, uses custom parameters provided in the request.
weirdnessConstraintnumber
Controls creative randomness. Value between 0 and 1, where 0 is conventional and 1 is highly experimental.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Extend Veo VideoKIEAI_EXTEND_VEO_VIDEOAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate Aleph VideoKIEAI_GENERATE_ALEPH_VIDEOAcción

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.

Parámetros de entrada

seedinteger
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.
promptstringObligatorio
Descriptive text prompt guiding the AI video generation. Include specific details about the subject, action, style, lighting, camera movement, and setting for best results.
uploadCnboolean
Upload method for the generated video. Set to true to upload to Alibaba Cloud OSS (for China region), or false for overseas R2 storage.
videoUrlstring
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.
waterMarkstring
Optional watermark text to add to the generated video. If empty or not provided, no watermark is added.
aspectRatiostringenum
Video aspect ratio for Aleph generation.
16:99:164:33:41:121:9
callBackUrlstring
Optional HTTPS URL to receive a POST callback when the video generation completes. The callback payload includes video URLs and task information.
referenceImagestring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate Music CoverKIEAI_GENERATE_COVERAcción

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.

Parámetros de entrada

task_idstringObligatorio
The original music task ID returned by the music generation interface. This identifies the source song to create a cover from.
call_back_urlstringObligatorio
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate Flux Kontext ImageKIEAI_GENERATE_FLUX_KONTEXT_IMAGEAcción

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.

Parámetros de entrada

modelstringenum
Available Flux Kontext models.
flux-kontext-proflux-kontext-max
promptstringObligatorio
Text description for image generation or editing. English language prompts are recommended for best results. Supports text-to-image generation and image editing modes.
watermarkstring
Optional watermark identifier to embed in the generated image. The watermark will be visible in the output if provided.
input_imagestring
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.
aspect_ratiostringenum
Supported aspect ratios for image generation.
21:916:94:31:13:49:16
callback_urlstring
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.
output_formatstringenum
Supported output formats for generated images.
jpegpng
safety_toleranceinteger
Moderation tolerance level from 0 (strictest) to 6 (most permissive). Lower values filter more content, higher values allow more creative freedom. Defaults to 2.
enable_translationboolean
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate GPT-4o ImageKIEAI_GENERATE_GPT4O_IMAGEAcción

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.

Parámetros de entrada

sizestringObligatorioenum
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).
1:13:22:3
promptstringObligatorio
Text description for the image to generate. Be specific and detailed for best results. English language prompts are recommended.
mask_urlstring
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.
files_urlstring[]
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.
is_enhanceboolean
Whether to enable automatic prompt enhancement. When true, the API will improve and expand your prompt for better results. Defaults to false.
n_variantsinteger
Number of image variants to generate. Valid values: 1, 2, or 4. Each variant will have a slightly different interpretation of the prompt.
callback_urlstring
Optional webhook URL to receive a POST callback when the generation task is complete. The callback will contain the task result with image URLs.
fallback_modelstringenum
Fallback model options when primary model is unavailable.
FLUX_MAXGPT_IMAGE_1
enable_fallbackboolean
Whether to enable automatic fallback to an alternative model if the primary model is unavailable. Defaults to false.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate AI LyricsKIEAI_GENERATE_LYRICSAcción

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.

Parámetros de entrada

promptstringObligatorio
Description of desired lyrics content. Maximum 200 characters. Specific themes, moods, styles, or story elements yield better results.
call_back_urlstringObligatorio
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate MIDIKIEAI_GENERATE_MIDIAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate Music StyleKIEAI_GENERATE_MUSIC_STYLEAcción

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.

Parámetros de entrada

contentstringObligatorio
Style description for music generation. Concise description of the desired music style. Example: 'Pop, Mysterious'

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate SoundsKIEAI_GENERATE_SOUNDSAcción

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.

Parámetros de entrada

modelstringenum
Available models for sound generation.
V5V5_5
promptstringObligatorio
Text description of the sound to generate. Limited to 500 characters.
sound_keystring
Musical key for the sound (e.g., 'Cm', 'D#m', 'Any').
sound_loopboolean
Whether the generated sound should loop seamlessly. Defaults to false.
grab_lyricsboolean
Whether to capture lyrics subtitles from the generated sound. Defaults to false.
sound_tempointeger
BPM (beats per minute) for the sound. Must be between 1 and 300.
call_back_urlstring
Callback URL to receive task completion notifications when the generation is finished.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Timestamped LyricsKIEAI_GENERATE_TIMESTAMPED_LYRICSAcción

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.

Parámetros de entrada

task_idstringObligatorio
Unique identifier of the music generation task, returned from 'Generate Music' or 'Extend Music' endpoints.
audio_idstringObligatorio
Unique identifier of the specific audio track for which to retrieve lyrics.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate Veo VideoKIEAI_GENERATE_VEO_VIDEOAcción

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.

Parámetros de entrada

modelstringenum
Veo model to use for generation. 'veo3' provides higher quality but slower generation. 'veo3_fast' generates faster with slightly reduced quality.
veo3veo3_fast
seedsinteger
Random seed for reproducible generation. If not specified, a random seed will be assigned. Range: 10000-99999.
promptstringObligatorio
Text prompt describing the desired video content. Include detailed descriptions of the scene, actions, camera movements, and visual style for best results.
imageUrlsstring[]
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.
watermarkstring
Optional watermark text to add to the generated video.
aspect_ratiostringenum
Video aspect ratio. '16:9' for landscape, '9:16' for portrait, 'Auto' for automatic detection based on content.
16:99:16Auto
call_back_urlstring
Optional HTTPS URL to receive a POST callback when the video generation completes. Must accept JSON payloads.
generation_typestringenum
Video generation mode.
TEXT_2_VIDEOFIRST_AND_LAST_FRAMES_2_VIDEOREFERENCE_2_VIDEO
enable_translationboolean
Whether to automatically translate the prompt to English. Defaults to true for optimal results.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Account CreditsKIEAI_GET_ACCOUNT_CREDITSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Aleph Video DetailsKIEAI_GET_ALEPH_VIDEO_DETAILSAcción

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).

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Cover DetailsKIEAI_GET_COVER_DETAILSAcción

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).

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Flux Kontext Image DetailsKIEAI_GET_FLUX_KONTEXT_IMAGE_DETAILSAcción

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

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get GPT-4o Image DetailsKIEAI_GET_GPT4O_IMAGE_DETAILSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Lyrics DetailsKIEAI_GET_LYRICS_DETAILSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Market Task DetailsKIEAI_GET_MARKET_TASK_DETAILSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get MIDI DetailsKIEAI_GET_MIDI_DETAILSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Music DetailsKIEAI_GET_MUSIC_DETAILSAcción

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.

Parámetros de entrada

taskIdstringObligatorio
Unique identifier of the music generation task to retrieve

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Music Video DetailsKIEAI_GET_MUSIC_VIDEO_DETAILSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Runway Video DetailsKIEAI_GET_RUNWAY_VIDEO_DETAILSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Timestamped Lyrics StatusKIEAI_GET_TIMESTAMPED_LYRICS_STATUSAcción

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.

Parámetros de entrada

task_idstringObligatorio
Unique identifier of the music generation task, returned from 'Generate Music' or 'Extend Music' endpoints.
audio_idstringObligatorio
Unique identifier of the specific audio track for which to retrieve lyrics.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Veo 1080p VideoKIEAI_GET_VEO1080P_VIDEOAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Veo 4K VideoKIEAI_GET_VEO4K_VIDEOAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Veo Video DetailsKIEAI_GET_VEO_VIDEO_DETAILSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get WAV DetailsKIEAI_GET_WAV_DETAILSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Replace Music SectionKIEAI_REPLACE_MUSIC_SECTIONAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Separate Vocals from AudioKIEAI_SEPARATE_VOCALSAcción

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.

Parámetros de entrada

typestringenum
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.
separate_vocalsplit_stem
task_idstringObligatorio
ID of the original music generation task. This identifies the parent task that generated the audio.
audio_idstringObligatorio
The specific audio track ID to process for vocal separation.
call_back_urlstringObligatorio
URL to receive task completion notifications. The API will send a callback when processing is complete.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not