API Doc-ElkAPI
  1. Quick Start
API Doc-ElkAPI
  • Quick Start
    • Quick Start
    • Must-read for beginners
    • ElkAPI Announcement
  • API Reference
    • Error status code description
    • OpenAI Format
      • Veo3-chat format
      • seedance
      • response
      • generate video
      • image
      • Image Editing (gpt-image-1)
      • embed
      • Realtime
      • Get model list
      • Response ID to obtain results
      • Hunyuan3D
    • 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. Quick Start

Must-read for beginners

How do I claim my $0.1 USD credit?#

No special action is required. After registering and logging in, you'll see the $0.1 USD credit on the Wallet page.

Which large model APIs are supported?#

All supported models and their prices can be found on the Pricing Page. All models shown on this page can be accessed through the ElkAPI.

How do I obtain my OpenAI Key, Claude Key, or Gemini Key?#

1.
A key is a token.
2.
After registering and logging in to the ElkAPI, click "Add Token" in the Token Management menu on the left.
3.
Enter a custom token name to generate a key.
This key can be used with GPT, Claude, and Gemini models.

How to Change Models?#

Change models by modifying the "model" parameter in the code.
Note that the full model name must be entered. For detailed instructions, please refer to the API documentation.

Pay-as-you-go or pay monthly?#

1.
Pay-as-you-go: Consists of the official pricing model, calculated based on token consumption. The unit is tokens, and you pay as you go.
No monthly subscription required, balance never expires, and unused portions are refundable.
2.
Special Model Billing: Image, music, and video models such as MidJourney, Suno, and Luma are billed based on usage.

Why are there three Base URLs? Which one should I use?#

Different development environments or software handle Base URLs differently.
Try the following three URLs:
https://api.elkapi.com/v1/
https://api.elkapi.com/v1/chat/completions/
https://api.elkapi.com/
If you encounter a 404 error, please check that the Base URL is set correctly.

Does ElkAPI support Claude 3.7 Sonnet?#

Yes! ElkAPI supports the full range of Claude models, including:
Sonnet
Haiku
Opus series

Which URL should I enter when using Anthropic Claude? What is the base URL?#

The base URL for all models is consistent:
This includes OpenAI, Claude series, Google Gemini, and other models.

How can I detect how many tokens were consumed by a call?#

1.
Go to the "Logs" page.
2.
Click a single log entry to expand the call details and view the calculation formula and token consumption:
Prompt: This is understood as a prompt.
Completion: This is understood as the AI's answer.

What do prompts and completions mean?#

Prompt: This refers to user input.
Completion: This refers to the AI's output.

Why is my balance negative? If your balance is very low and the cost of your last call exceeds your balance, your balance will be negative.#

Please top up promptly to continue using your account.
Previous
Quick Start
Next
ElkAPI Announcement
Built with