API Doc-ElkAPI
  1. OpenAI Format
API Doc-ElkAPI
  • Quick Start
    • Quick Start
    • Must-read for beginners
    • ElkAPI Announcement
  • API Reference
    • Error status code description
    • OpenAI Format
      • Veo3-chat format
        POST
      • seedance
        POST
      • response
        POST
      • generate video
        POST
      • image
        POST
      • Image Editing (gpt-image-1)
        POST
      • embed
        POST
      • Realtime
        POST
      • Get model list
        GET
      • Response ID to obtain results
        GET
      • Hunyuan3D
        POST
    • Anthropic Format
      • Anthropic Claude
    • Midjourney Image Generation
      • Quick teaching-complete process in one go
      • Task Query
        • pagination query
        • Specify ID to obtain task
      • Submit Imagine task
      • Submit video task
      • Submit editing task
      • Submit Action Task
      • Submit Blend task
      • Submit Describe task
      • Submit Modal
    • Image Generation
      • ideogram(images)
        • Official documentation (updated in real time)
        • Generate 3.0 (illustrated in the text)
        • Reframe 3.0 (Refactoring)
        • Replace Background 3.0
        • Remix 3.0 (Mixed Graph)
        • Edit 3.0 (Edit)
        • Generate (text and image)
        • Remix (mixed image)
        • Upscale (enlarged high-definition)
        • Describe
        • Edit
      • Flux(images)
        • Create Task - General
        • generate image
        • Fine tuning (temporarily unavailable)
        • query task
        • Generate image (replica format)
      • Replicate(image)
        • Create Task - General
        • Create task - float kontext pro, max
        • Create task-black forest labs/flux-1.1-pro
        • Create task-black forest labs/flux-1.1-pro ultra
        • query task
        • Create task
      • Recraft(images)
        • Generate Image
        • Vectorize Image
        • Remove Background
        • Clarity Upscale
        • Create style
        • Generative Upscale
    • Music Generation
      • Suno
        • Set suno version
        • Suno API Scenario Application Guide
        • Generate lyrics
        • Generate music
        • Upload music
        • Song Splicing
        • Full track acoustic separation
        • Single track acoustic separation
        • Create a new Persona
        • Query a single task
        • Generate MP4 MV video
        • Retrieve WAV format files
        • Timing: Lyrics, audio timeline
        • Batch query task
        • Create music using persona_id
      • Udio (not available yet)
        • Generate music
        • Query a single task
    • Video Generation
      • veo3
        • veo3-chat format
        • Submit video generation task
        • Check the video generation status
      • Dream Test
        • seedance
      • runway(video)
        • Official format
          • Generate videos from images
          • Get detailed task information
        • Reverse format
          • Generate (text)
          • Generate (refer to image)
          • Video2video video to video style redrawing
          • Act one emoji transfer
          • Feed - Get Task
      • kling (video)
        • Callback Protocol
        • image expansion
        • generate image
        • text-to-video
        • image-to-video
        • Video extension
        • Virtual try on
        • lip-sync
        • video effects
        • Query task (single)
      • luma (video)
        • Official API format
          • generate video
          • Single query task
      • MiniMax Conch (video)
        • Official Documentation
        • video generation
        • query task
        • File Download
      • PIKA(video)
        • Universal version
          • generate video
          • Query video tasks
        • Generate (reference video/extended video)
        • Generate (refer to image)
        • Generate (text)
        • feed
      • sora
        • Reverse format
          • Create video
          • Generate Video
          • Query video tasks
    • Audio
      • Text to audio conversion
      • audio to text
      • Create translation
  • Integration Guide
    • Best Practices
      • Claude code access instructions
      • ElkAPI Account Balance Query API Usage Instructions
      • Retry logic documentation using ElkAPI and OpenAI's official API
      • Midjorney Calling Best Practices
      • Runway Call Best Practices
    • Application Integration Guide
  • Pricing and Billing
    • About Price
    • About Grouping
  • Help Center
    • Help Center
    • Interface stability
    • Common Misconceptions
    • Use confusion
    • Privacy Policy
    • Terms of Service
  1. OpenAI Format

image

POST
https://api.elkapi.com/v1/images/generations
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.

Request Body#

model (string, required): The model to use for image generation.
prompt (string, required): The prompt to use for image generation.
n (integer, required): The number of images to generate.
size (string, required): The size of the generated image.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Successful Response
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.elkapi.com/v1/images/generations' \
--header 'Authorization: {{api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "gpt-image-1",
    "prompt": "A cute baby sea otter",
    "n": 1,
    "stream": true,
    "size": "1024x1024"
}'
Response Response Example
{
  "created": 1737352021,
  "data": [
    {
      "revised_prompt": "A small and adorable sea otter pup. It's floating on its back in a tranquil, azure sea, sunlight streaming down on its thick, wet fur. The otter pup is contentedly munching on a bright pink shrimp, holding it between its little paws while remaining completely buoyant, displaying its nimble acrobatic skills that come naturally to its species. The pup's eyes are bright with curiosity and innocence, exploring the vast sea around it while enjoying its meal. The blue-green water around it is dancing with the sunlight, creating a serene environment for the otter pup's mealtime.",
      "url": "https://oaidalleapiprodscus.blob.core.windows.net/private/org-nRhUPivdBTlVXzF8KaZBo9vY/user-IuAvdMlDArmYuupuySzt6BqQ/img-AtYEsUJaP70OFEPyqFbSuxSE.png?st=2025-01-20T04%3A47%3A01Z&se=2025-01-20T06%3A47%3A01Z&sp=r&sv=2024-08-04&sr=b&rscd=inline&rsct=image/png&skoid=d505667d-d6c1-4a0a-bac7-5c84a87759f8&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skt=2025-01-20T00%3A45%3A01Z&ske=2025-01-21T00%3A45%3A01Z&sks=b&skv=2024-08-04&sig=Op4s4mFKwrX6i/O43KZ/23EAWY2LnQTfY2ooxaFZNM0%3D"
    }
  ]
}
Previous
generate video
Next
Image Editing (gpt-image-1)
Built with