#  API Doc-ElkAPI

## Docs
- Quick Start [Quick Start](https://apidoc.elkapi.com/doc-1807407.md): 
- Quick Start [Must-read for beginners](https://apidoc.elkapi.com/doc-1807408.md): 
- Quick Start [ElkAPI Announcement](https://apidoc.elkapi.com/doc-1807409.md): 
- API Reference [Error status code description](https://apidoc.elkapi.com/doc-1807410.md): 
- API Reference > Midjourney Image Generation [Quick teaching-complete process in one go](https://apidoc.elkapi.com/doc-1807411.md): 
- API Reference > Image Generation > ideogram(images) [Official documentation (updated in real time)](https://apidoc.elkapi.com/doc-1807412.md): 
- API Reference > Music Generation > Suno [Set suno version](https://apidoc.elkapi.com/doc-1807414.md): 
- API Reference > Music Generation > Suno [Suno API Scenario Application Guide](https://apidoc.elkapi.com/doc-1807415.md): 
- API Reference > Video Generation > kling (video) [Callback Protocol](https://apidoc.elkapi.com/doc-1807416.md): 
- API Reference > Video Generation > MiniMax Conch (video) [Official Documentation](https://apidoc.elkapi.com/doc-1807417.md): 
- Integration Guide > Best Practices [Claude code access instructions](https://apidoc.elkapi.com/doc-1807420.md): 
- Integration Guide > Best Practices [ElkAPI Account Balance Query API Usage Instructions](https://apidoc.elkapi.com/doc-1807421.md): 
- Integration Guide > Best Practices [Retry logic documentation using ElkAPI and OpenAI's official API](https://apidoc.elkapi.com/doc-1807422.md): 
- Integration Guide > Best Practices [Midjorney Calling Best Practices](https://apidoc.elkapi.com/doc-1807423.md): 
- Integration Guide > Best Practices [Runway Call Best Practices](https://apidoc.elkapi.com/doc-1807424.md): 
- Pricing and Billing [About Price](https://apidoc.elkapi.com/doc-1807425.md): 
- Pricing and Billing [About Grouping](https://apidoc.elkapi.com/doc-1807426.md): 
- Help Center [Help Center](https://apidoc.elkapi.com/doc-1807427.md): 
- Help Center [Interface stability](https://apidoc.elkapi.com/doc-1807428.md): 
- Help Center [Common Misconceptions](https://apidoc.elkapi.com/doc-1807429.md): 
- Help Center [Use confusion](https://apidoc.elkapi.com/doc-1807430.md): 
- Help Center [Privacy Policy](https://apidoc.elkapi.com/doc-1807431.md): 
- Help Center [Terms of Service](https://apidoc.elkapi.com/doc-1807432.md): 

## API Docs
- API Reference > OpenAI Format [Veo3-chat format](https://apidoc.elkapi.com/api-24834007.md): 🌟  Precautions for using Veo3 video:-Due to the fact that this interface is implemented through technical means, there may be slight instability
- API Reference > OpenAI Format [seedance](https://apidoc.elkapi.com/api-24834008.md): 
- API Reference > OpenAI Format [response](https://apidoc.elkapi.com/api-24834009.md): Used to send a request to generate a chat completion message. The request should contain a `model` parameter to specify the model to use; an `input` list containing the role and message content;
- API Reference > OpenAI Format [generate video](https://apidoc.elkapi.com/api-24834010.md): 
- API Reference > OpenAI Format [image](https://apidoc.elkapi.com/api-24834011.md): This API endpoint allows you to generate images based on a provided model, prompt, and other parameters. Use the streaming output to observe the progress in real time.
- API Reference > OpenAI Format [Image Editing (gpt-image-1)](https://apidoc.elkapi.com/api-24834012.md): Official Documentation:
- API Reference > OpenAI Format [embed](https://apidoc.elkapi.com/api-24834013.md): This API endpoint allows you to generate embeddings for text using a specific model.
- API Reference > OpenAI Format [Realtime](https://apidoc.elkapi.com/api-24834014.md): Just a brief introduction to the required parameters, please refer to the official document for more detailed integration content: https://platform.openai.com/docs/guides/realtime/overview
- API Reference > OpenAI Format [Get model list](https://apidoc.elkapi.com/api-24834015.md): This endpoint retrieves information about all available models.
- API Reference > OpenAI Format [Response ID to obtain results](https://apidoc.elkapi.com/api-24834016.md): 
- API Reference > OpenAI Format [Hunyuan3D](https://apidoc.elkapi.com/api-24834017.md): 
- API Reference > Anthropic Format [Anthropic Claude](https://apidoc.elkapi.com/api-24834018.md): This endpoint is used to create a chat completion using the same format and parameters as Anthropic Claude. This endpoint only supports the Claude model. Please see the full list of supported models in [Model List and Pricing](https://api.elkapi.com/pricing).
- API Reference > Midjourney Image Generation > Task Query [pagination query](https://apidoc.elkapi.com/api-24834026.md): Obtain the status of one or more intermediate tasks
- API Reference > Midjourney Image Generation > Task Query [Specify ID to obtain task](https://apidoc.elkapi.com/api-24834027.md): Quickly and stably obtain the status of a single intermediate task.
- API Reference > Midjourney Image Generation [Submit Imagine task](https://apidoc.elkapi.com/api-24834019.md): Create image generation tasks using the UniAgi Midjourney API, supporting all the same parameters as in the Midjourney Discord Channel.
- API Reference > Midjourney Image Generation [Submit video task](https://apidoc.elkapi.com/api-24834020.md): 
- API Reference > Midjourney Image Generation [Submit editing task](https://apidoc.elkapi.com/api-24834021.md): 1: Edit Image
- API Reference > Midjourney Image Generation [Submit Action Task](https://apidoc.elkapi.com/api-24834022.md): Submit a task to perform all operations on the images you create through the imaging API, including UPSCALE, VARIATION, REROLL, ZOOM, etc.
- API Reference > Midjourney Image Generation [Submit Blend task](https://apidoc.elkapi.com/api-24834023.md): Generate a new image using one or more images.
- API Reference > Midjourney Image Generation [Submit Describe task](https://apidoc.elkapi.com/api-24834024.md): Detect initial hints from uploaded images.
- API Reference > Midjourney Image Generation [Submit Modal](https://apidoc.elkapi.com/api-24834025.md): Submit the modality generated by scaling or region redesign operation, and proceed to the next step of image editing.
- API Reference > Image Generation > ideogram(images) [Generate 3.0 (illustrated in the text)](https://apidoc.elkapi.com/api-24834028.md): Uses the Ideogram 3.0 model to synchronously generate an image based on a given prompt and optional parameters.
- API Reference > Image Generation > ideogram(images) [Reframe 3.0 (Refactoring)](https://apidoc.elkapi.com/api-24834029.md): Reframes a square image to a selected resolution using Ideogram 3.0. Supported image formats include JPEG, PNG, and WebP.
- API Reference > Image Generation > ideogram(images) [Replace Background 3.0](https://apidoc.elkapi.com/api-24834030.md): Synchronously replaces the background of a given image using Ideogram 3.0 prompts. The foreground subject will be identified and retained, while the background will be replaced based on the prompt and selected style. Supported image formats include JPEG, PNG, and WebP. The image link is available for a limited time; if you want to keep the image, you must download it.
- API Reference > Image Generation > ideogram(images) [Remix 3.0 (Mixed Graph)](https://apidoc.elkapi.com/api-24834031.md): Remix serves images in sync with an Ideogram 3.0 model based on given prompts and optional parameters.
- API Reference > Image Generation > ideogram(images) [Edit 3.0 (Edit)](https://apidoc.elkapi.com/api-24834032.md): Use the provided mask and Ideogram 3.0 to edit the given image simultaneously. The mask indicates which part of the image should be edited, while the hint and selected style further guide the editing process.
- API Reference > Image Generation > ideogram(images) [Generate (text and image)](https://apidoc.elkapi.com/api-24834033.md): Generates images synchronously based on a given prompt and optional parameters.
- API Reference > Image Generation > ideogram(images) [Remix (mixed image)](https://apidoc.elkapi.com/api-24834034.md): Remix provided images synchronously based on a given prompt and optional parametersProvide real-time remixed images based on given prompts and optional parameters
- API Reference > Image Generation > ideogram(images) [Upscale (enlarged high-definition)](https://apidoc.elkapi.com/api-24834035.md): Upscale provided images synchronously with an optional prompt.Provide a high-resolution version of the image with optional accompanying prompts.
- API Reference > Image Generation > ideogram(images) [Describe](https://apidoc.elkapi.com/api-24834036.md): Describe an imageDescribe an image
- API Reference > Image Generation > ideogram(images) [Edit](https://apidoc.elkapi.com/api-24834037.md): Remix provided images synchronously based on a given prompt and optional parametersProvide real-time remixed images based on given prompts and optional parameters
- API Reference > Image Generation > Flux(images) [Create Task - General](https://apidoc.elkapi.com/api-24834038.md): https://replicate.com/black-forest-labs
- API Reference > Image Generation > Flux(images) [generate image](https://apidoc.elkapi.com/api-24834039.md): https://api.bfl.ml/scalar#tag/tasks/POST/v1/flux -proPlease refer to the official documentation, all parameters are consistent with the official documentation.
- API Reference > Image Generation > Flux(images) [Fine tuning (temporarily unavailable)](https://apidoc.elkapi.com/api-24834040.md): Fully synchronize official documentshttps://api.bfl.ml/scalar#tag/tasks/POST/v1/finetune
- API Reference > Image Generation > Flux(images) [query task](https://apidoc.elkapi.com/api-24834041.md): https://api.bfl.ml/scalar#tag/tasks/POST/v1/flux -proPlease refer to the official documentation, all parameters are consistent with the official documentation.
- API Reference > Image Generation > Flux(images) [Generate image (replica format)](https://apidoc.elkapi.com/api-24834042.md): https://replicate.com/docs/reference/http
- API Reference > Image Generation > Replicate(image) [Create Task - General](https://apidoc.elkapi.com/api-24834043.md): https://replicate.com/black-forest-labsNote: To call different models of flux, you need to switch the model name in the URL after the model is called:black-forest-labs/flux-kontext-maxblack-forest-labs/flux-kontext-problack-forest-labs/flux-schnellblack-forest-labs/flux-problack-forest-labs/flux-devblack-forest-labs/flux-1.1-pro-ultrablack-forest-labs/flux-1.1-pro
- API Reference > Image Generation > Replicate(image) [Create task - float kontext pro, max](https://apidoc.elkapi.com/api-24834044.md): https://replicate.com/docs/reference/httpNote: To call the following different models, you need to switch the model name after the model in the URL:black-forest-labs/flux-kontext-maxblack-forest-labs/flux-kontext-pro
- API Reference > Image Generation > Replicate(image) [Create task-black forest labs/flux-1.1-pro](https://apidoc.elkapi.com/api-24834045.md): https://replicate.com/docs/reference/httpNote: To call different models of flux, you need to switch the model name after the model in the URL
- API Reference > Image Generation > Replicate(image) [Create task-black forest labs/flux-1.1-pro ultra](https://apidoc.elkapi.com/api-24834046.md): https://replicate.com/black-forest-labsNote: To call different models of flux, you need to switch the model name after the model in the URL
- API Reference > Image Generation > Replicate(image) [query task](https://apidoc.elkapi.com/api-24834047.md): 
- API Reference > Image Generation > Replicate(image) [Create task](https://apidoc.elkapi.com/api-24834048.md): https://replicate.com/docs/reference/http
- API Reference > Image Generation > Recraft(images) [Generate Image](https://apidoc.elkapi.com/api-24834049.md): Generate images based on text prompts:https://www.recraft.ai/docs
- API Reference > Image Generation > Recraft(images) [Vectorize Image](https://apidoc.elkapi.com/api-24834050.md): Convert bitmap images to vector graphics
- API Reference > Image Generation > Recraft(images) [Remove Background](https://apidoc.elkapi.com/api-24834051.md): Delete image background
- API Reference > Image Generation > Recraft(images) [Clarity Upscale](https://apidoc.elkapi.com/api-24834052.md): Improve image clarity
- API Reference > Image Generation > Recraft(images) [Create style](https://apidoc.elkapi.com/api-24834053.md): https://www.recraft.ai/docs
- API Reference > Image Generation > Recraft(images) [Generative Upscale](https://apidoc.elkapi.com/api-24834054.md): https://www.recraft.ai/docs
- API Reference > Music Generation > Suno [Generate lyrics](https://apidoc.elkapi.com/api-24834055.md): #### Generate lyricsThrough this endpoint, you can generate lyrics with specified prompts.
- API Reference > Music Generation > Suno [Generate music](https://apidoc.elkapi.com/api-24834056.md): ### Generate Music Clips
- API Reference > Music Generation > Suno [Upload music](https://apidoc.elkapi.com/api-24834057.md): ### Uploading an Audio Clip
- API Reference > Music Generation > Suno [Song Splicing](https://apidoc.elkapi.com/api-24834058.md): This endpoint allows submission of song stitching tasks.
- API Reference > Music Generation > Suno [Full track acoustic separation](https://apidoc.elkapi.com/api-24834059.md): # 🎵 Audio Track Generation Process 🎵
- API Reference > Music Generation > Suno [Single track acoustic separation](https://apidoc.elkapi.com/api-24834060.md): # 🎵 Audio Track Generation Process 🎵
- API Reference > Music Generation > Suno [Create a new Persona](https://apidoc.elkapi.com/api-24834061.md): # 🎵 Generate Persona: Singer Style Process 🎵
- API Reference > Music Generation > Suno [Query a single task](https://apidoc.elkapi.com/api-24834062.md): This endpoint issues an HTTP GET request to retrieve detailed information about a specific task identified by task_id.
- API Reference > Music Generation > Suno [Generate MP4 MV video](https://apidoc.elkapi.com/api-24834063.md): 
- API Reference > Music Generation > Suno [Retrieve WAV format files](https://apidoc.elkapi.com/api-24834064.md): 
- API Reference > Music Generation > Suno [Timing: Lyrics, audio timeline](https://apidoc.elkapi.com/api-24834065.md): 
- API Reference > Music Generation > Suno [Batch query task](https://apidoc.elkapi.com/api-24834066.md): ### Get Suno Data
- API Reference > Music Generation > Suno [Create music using persona_id](https://apidoc.elkapi.com/api-24834067.md): Note that mv is chirp-v3-5-tau, chirp-v4-tau, or chirp-auk.
- API Reference > Music Generation > Udio (not available yet) [Generate music](https://apidoc.elkapi.com/api-24834068.md): Detailed description:
- API Reference > Music Generation > Udio (not available yet) [Query a single task](https://apidoc.elkapi.com/api-24834069.md): ### Udio Task Query
- API Reference > Video Generation > veo3 [veo3-chat format](https://apidoc.elkapi.com/api-24834070.md): 🌟 使用veo3视频注意事项：
- API Reference > Video Generation > veo3 [Submit video generation task](https://apidoc.elkapi.com/api-24834071.md): Submit video generation task, supporting text description and reference images
- API Reference > Video Generation > veo3 [Check the video generation status](https://apidoc.elkapi.com/api-24834072.md): Query video generation status and results based on task ID
- API Reference > Video Generation > Dream Test [seedance](https://apidoc.elkapi.com/api-24834073.md): 
- API Reference > Video Generation > runway(video) > Official format [Generate videos from images](https://apidoc.elkapi.com/api-24834074.md): By providing image URLs and using AI models to convert static images into dynamic videos:https://docs.dev.runwayml.com/api/
- API Reference > Video Generation > runway(video) > Official format [Get detailed task information](https://apidoc.elkapi.com/api-24834075.md): Retrieve detailed information and progress of video generation tasks by task ID:https://docs.dev.runwayml.com/api/
- API Reference > Video Generation > runway(video) > Reverse format [Generate (text)](https://apidoc.elkapi.com/api-24834076.md): Here is a simple example of GEN-4 text video value transfer
- API Reference > Video Generation > runway(video) > Reverse format [Generate (refer to image)](https://apidoc.elkapi.com/api-24834077.md): Here is a simple example of GEN-4 image generated video value transfer:
- API Reference > Video Generation > runway(video) > Reverse format [Video2video video to video style redrawing](https://apidoc.elkapi.com/api-24834078.md): Video to Video Conversion: Easily Change Video Style
- API Reference > Video Generation > runway(video) > Reverse format [Act one emoji transfer](https://apidoc.elkapi.com/api-24834079.md): Currently only supports 16:9 videos and images
- API Reference > Video Generation > runway(video) > Reverse format [Feed - Get Task](https://apidoc.elkapi.com/api-24834080.md): 
- API Reference > Video Generation > kling (video) [image expansion](https://apidoc.elkapi.com/api-24834081.md): This document is not updated in real-time. Please refer to the official document for the complete version: https://app.klingai.com/cn/dev/document-api/apiReference/model/textToVideo
- API Reference > Video Generation > kling (video) [generate image](https://apidoc.elkapi.com/api-24834082.md): This document is not updated in real-time. Please refer to the official document for the complete version: https://app.klingai.com/cn/dev/document-api/apiReference/model/textToVideo
- API Reference > Video Generation > kling (video) [text-to-video](https://apidoc.elkapi.com/api-24834083.md): This document is not updated in real-time. Please refer to the official document for the complete version: https://app.klingai.com/cn/dev/document-api/apiReference/model/textToVideo
- API Reference > Video Generation > kling (video) [image-to-video](https://apidoc.elkapi.com/api-24834084.md): This document is not updated in real-time. Please refer to the official document for the complete version: https://app.klingai.com/cn/dev/document-api/apiReference/model/textToVideo
- API Reference > Video Generation > kling (video) [Video extension](https://apidoc.elkapi.com/api-24834085.md): 1. Generate video2. This interface requires the task ID and video ID to be passed inThis interface belongs to a subtask and needs to be used on the parent task account. Please operate as soon as possible to avoid resource package expiration.Official document: https://app.klingai.com/cn/dev/document-api/apiReference/model/textToVideo
- API Reference > Video Generation > kling (video) [Virtual try on](https://apidoc.elkapi.com/api-24834086.md): Official document: https://app.klingai.com/cn/dev/document-api/apiReference/model/textToVideo
- API Reference > Video Generation > kling (video) [lip-sync](https://apidoc.elkapi.com/api-24834087.md): 1. Generate video2. This interface requires the task ID and video ID to be passed inThis interface belongs to a subtask and needs to be used on the parent task account. Please operate as soon as possible to avoid resource package expiration.Official document: https://app.klingai.com/cn/dev/document-api/apiReference/model/textToVideo
- API Reference > Video Generation > kling (video) [video effects](https://apidoc.elkapi.com/api-24834088.md): This document is not updated in real-time. Please refer to the official document for the complete version: https://docs.qingque.cn/d/home/eZQClW07IFEuX1csc-VejdY2M
- API Reference > Video Generation > kling (video) [Query task (single)](https://apidoc.elkapi.com/api-24834089.md): This document is not updated in real-time. Please refer to the official document for the complete version: https://app.klingai.com/cn/dev/document-api/apiReference/model/textToVideo
- API Reference > Video Generation > luma (video) > Official API format [generate video](https://apidoc.elkapi.com/api-24834090.md): 
- API Reference > Video Generation > luma (video) > Official API format [Single query task](https://apidoc.elkapi.com/api-24834091.md): 
- API Reference > Video Generation > MiniMax Conch (video) [video generation](https://apidoc.elkapi.com/api-24834092.md): Generate videos based on prompt words
- API Reference > Video Generation > MiniMax Conch (video) [query task](https://apidoc.elkapi.com/api-24834093.md): Query the status and results of video generation tasks
- API Reference > Video Generation > MiniMax Conch (video) [File Download](https://apidoc.elkapi.com/api-24834094.md): Download the generated file
- API Reference > Video Generation > PIKA(video) > Universal version [generate video](https://apidoc.elkapi.com/api-24834099.md): 
- API Reference > Video Generation > PIKA(video) > Universal version [Query video tasks](https://apidoc.elkapi.com/api-24834100.md): Field type descriptionID string Task IDPromptText string prompt wordVideos arrayVideos []. id string Video IDVideos []. status string Video status completed, error, errorVideos []. sed number Video torrentVideos []. resultURL string Video addressVideos []. videoPoster string Cover imageVideos []. sharingURL string Video sharing addressVideos []. error string indicates an error when the status is' error 'Progress of videos []. progress number
- API Reference > Video Generation > PIKA(video) [Generate (reference video/extended video)](https://apidoc.elkapi.com/api-24834095.md): 
- API Reference > Video Generation > PIKA(video) [Generate (refer to image)](https://apidoc.elkapi.com/api-24834096.md): Generate content based on the provided reference image URL and prompt words
- API Reference > Video Generation > PIKA(video) [Generate (text)](https://apidoc.elkapi.com/api-24834097.md): Generate content based on the provided text promptsUpgraded to Pika 1.5 versionMainly due to some changes in the style parameter
- API Reference > Video Generation > PIKA(video) [feed](https://apidoc.elkapi.com/api-24834098.md): Non essential interface
- API Reference > Video Generation > sora > Reverse format [Create video](https://apidoc.elkapi.com/api-24834101.md): 
- API Reference > Video Generation > sora > Reverse format [Generate Video](https://apidoc.elkapi.com/api-24834102.md): 
- API Reference > Video Generation > sora > Reverse format [Query video tasks](https://apidoc.elkapi.com/api-24834103.md): 
- API Reference > Audio [Text to audio conversion](https://apidoc.elkapi.com/api-24834104.md): This endpoint allows you to convert text to speech using the specified model and voice.
- API Reference > Audio [audio to text](https://apidoc.elkapi.com/api-24834105.md): This endpoint allows you to transcribe an audio file using the specified model and parameters.
- API Reference > Audio [Create translation](https://apidoc.elkapi.com/api-24834106.md): This endpoint is used to request audio translation using the specified parameters.