GoAPI
HomeDashboard
HomeDashboard
Join Discord
    • Get Started
    • Endpoints
      • Flux
        • Flux API with Redux Variation, Fill, Inpaint and Outpaint
        • Flux with LoRA and Controlnet
        • Available LoRA and Controlnet
        • Create Task
          • Text to Image
          • Image to Image
          • Kontext
        • Get Task
      • Gemini
        • Gemini-2.5-flash-image
        • Nano Banana Pro
        • Nano Banana 2
        • Get Task
      • Veo3
        • Veo3 Text to Video
        • Veo3 Image to Video
        • Veo3.1 Text to Video
        • Veo3.1 Image to Video
        • Get Task
      • Sora2
        • Sora2-preview Text to Video
        • Sora2 Text to Video
        • Sora2-Pro Text to Video
        • Sora2 Remove Watermark
        • Get Task
      • Omni Human
        • Omni Human 1.5
        • Get Task
      • Seedance
        • Moderation and Penalty
        • Seedance 2 preview
        • Seedance 2
        • Video Watermark Remover
        • Get Task
      • Seedream
        • Seedream 5 Lite
        • Get Task
      • Qwen Image
        • Text to Image
        • Image Edit
        • Get Task
      • Z-Image
        • Text to Image
        • Get Task
      • AI Hug
        • Create Task
        • Get Task
      • Midjourney
        • Detailed Explaination on Midjourney Task Result
        • GoAPI Penalties on Midjourney Usage
        • Midjourney V7 Instructions
        • Create Task
          • Imagine
          • Upscale
          • Variation
          • Reroll
          • Describe
          • Seed
          • Blend
          • Inpaint
          • Outpaint
          • Pan
        • Cancel Task
          • Cancel Task
          • Cancel Tasks
        • Get Task
      • Faceswap
        • Multi Faceswap
        • Image Faceswap
        • Video Faceswap
        • Get Task
      • Suno
        • Music
        • Lyrics
        • Get Task
      • Song (Udio)
        • Song API Task Creation Examples(Udio and Suno)
        • [Udio] Song Extend
        • Create Task
        • [Udio] Generate Lyrics
        • Get Task
      • TTS
        • Zeroshot Text-to-Speech F5-TTS
        • Get Task
      • DiffRhythm
        • Generate an Audio
        • Get Task
      • Ace Step
        • Create Task
          • Text to Audio
          • Audio to Audio
          • Audio Edit
          • Audio Extend
        • Get Task
      • Joycaption
        • Image Caption
        • Get Task
      • Mmaudio
        • Generate Audio
        • Get task
      • Dream Machine
        • Create Task
        • Get Task
      • Kling
        • Lipsync API Examples
        • Motion Brush Example
        • Kling Elements Video Generation API
        • Kling Effects Video Generation
        • Cancel Task
          • Cancel Task
          • Cancel Tasks
        • Create Task
        • Get Task
        • Kling Virtual Try-On
        • Kling Effects
        • Kling Sound
        • Kling Avatar
        • Kling Motion Control
        • Kling Turbo
        • Kling 3.0
      • Kling Omni
        • Kling o1
        • Kling 3.0 omni
        • Get Task
      • Hailuo
        • Generate Video
        • Get Task
      • Hunyuan Video
        • How to Make a Hunyuan API Call
        • Available Hunyuan Lora models
        • Generate Video
        • Get Task
      • WanX
        • Generate WanX Task with LoRA Using GoAPI
        • Available LoRA Types for Wanx
        • Use Cases for Wanx LoRA
        • Use Cases for Wanx Control Camera
        • Create Task
        • Get Task
      • Wan
        • Wan2.6 Text to Video
        • Wan2.6 Image to Video
        • Get Task
      • Skyreels
        • Create Task
        • Get Task
      • Framepack
        • Create Task
        • Get Task
      • Trellis
        • Trellis Create Task
        • Trellis2 Create Task
        • Get Task
      • GPTs API
        • ChatGPT Account Configuration
        • Examples for files upload into conversations in GPTs API
        • Conversation API
          • Create conversation
          • Add message to conversation
          • Upload file to conversation
          • Download file from code interpretor's sandbox
          • Download file from conversation
          • Get Task
      • LLM
        • LLM API | Basic Completions
        • Transcription API
        • TTS API
        • Embeddings API
        • Dall E 3 API
      • Account Management
        • Account Notification Webhook
        • Account Info
        • Task List Info
        • User Task History
      • Tools
        • File Upload API
        • Remove Background API
        • Remove Background-Get task
        • Segment With Prompt API
        • Segment with Prompt-Get task Copy
        • Image Upscale(Super Resolution) API
        • Image Upscale-Get task
        • Video Upscale
        • Video Upscale-Get task
        • Video Remove Background
        • Video Remove Background-Get task
      • GPT-image
        • GPT-image API
      • Seedance 2
    • Resources
      • Pricing Plan
      • Unified API Schema
      • Unified API Webhook
      • Technical Questions
      • Bulk Generation Service
      • Change Log
      • Common Error Message
      • Output Storage
      • Dashboard Manual
        • BYOA | Back-up Account
        • BYOA | Debug Checklist
        • BYOA | Connected Account Status
      • Announcements
        • GoAPI 2025 January 1st Pricing Update
        • The discontinued support for midjourney
        • Sunsetting Suno
    • Schemas
      • Sample Schemas
        • Pet
        • Category
        • Tag
      • Schemas
        • Motion Brush
        • Float2 Point
        • Control Points
        • txt2video-1.3b
        • txt2video-14b
        • txt2video-14b-lora
        • img2video-14b
        • img2video-14b-lora
        • img2video-14b-keyframe
        • img2video-14b-control-camera
        • wan22-txt2video-14b
        • wan22-img2video-14b
        • ErrorResponse
        • Trellis API/text-to-3D
        • Trellis API/image-to-3D
        • Trellis2 API/image-to-3D
        • Create Task
        • VideoGenerationResponse
        • camera control
        • Cancel Params
        • TaskConfig
        • TaskResponse
      • Response
        • Unified-Task-Response
      • RequestBodies
        • Unified-Task-Request-Body
      • config
      • control_net_setting
      • lora_setting
      • Kling omni multi shot

    Get Started

    Getting Started with GoAPI!#

    The complete documentation of all APIs offered by GoAPI!

    Introduction#

    Unlock the full potential of your websites and applications with all-in-one AI API solution, offering Midjourney API, GPTs API, Kling API, and more. Experience the simplicity, cost-effectiveness, and seamless integration that our APIs provide, empowering your digital projects!

    Getting started#

    Sign up for our Dashboard and get free credits to try out our different generative AI APIs!
    Our dashboard is where you can manage your credits, subscriptions, API Key, referrals, and more!

    What is PPU vs BYOA?#

    PPU: “Pay-per-use”, or “Pay-as-you-go”, is a service option where you don’t have to have your own Midjourney/ChatGPT/Kling/Luma/Suno/etc accounts depending on the API you want to use, and you will be using the account pool operated by us and it will consume your credits (which you can get more by topping up). Thus, all the jobs submitted will be processed by our accounts.
    The PPU service option will consume your GoAPI credits, which you can top-up on the dashboard.

    BYOA: “Bring-your-own-account”, or “Host-your-account”, is a service option where you do need to have and operate your own Midjourney/ChatGPT/Kling/Luma/Suno/etc accounts, and then subscribe to a seat or multiple seats on our platform for that particular API, connect your account to that seat, and then start using the API. Thus, all the jobs submitted will be processed by your own accounts.
    The BYOA service option will require you to subscribe to BYOA seats for that particular API you want to use. You will not need to top-up GoAPI credits for BYOA.

    Reliability: the most reliable way is to for you to use both PPU and BYOA to reduce the possibility of downtime associated with account operation related issues (ex. Midjourney API). For example, you could primarily use PPU and have your own BYOA as backup; or in the case of Midjourney API, you could use your BYOA accounts and failover to our PPU (there is a toggle for this fail over logic on the dashboard).
    Below is an example illustration for Midjourney API. Similar logic applies to Suno API, Kling API, Luma API, GPTs API, etc.
    A screesnhot showing the difference between PPU vs BYOA mode

    Making your first request#

    To make your first Flux API request, send an authenticated request to the following endpoint, and you will get a response shortly afterwards.
    Find a list of GoAPI's available domains here

    Example Request#

    POST
    https://api.goapi.ai/api/v1/task
    Header Parameters
    {
        "model": "Qubico/flux1-schnell",
        "task_type": "txt2img",
        "input": {
            "prompt": "a bear",
        },
        "config": {
            "webhook_config": {
                "endpoint": "",
                "secret": ""
            }
        }
    }
    Response Codes
    StatusDescription
    200: OKSuccessful Response
    400: Bad RequestThe request format does not meet the requirements.
    401: UnauthorizedThe API key is incorrect
    500: Internal Server ErrorService is experiencing an error

    Example Response#

    {
        "code": 200,
        "message": "success",
        "data": {
            "task_id": "0f647527-12bd-48b1-b813-111111111",
            "model": "Qubico/flux1-dev", 
            "task_type": "txt2img",
            "status": "", // pending/processing/failed/completed
            "input": {}, 
            "output": {}, 
            "meta": { 
            },
            "logs": [],
            "error": {
                "code": 1100,
                "message": ""
            } 
        }
    }


    GoAPI Domains#

    Here are the available domains for all of our API endpoints. we recommend you to experiment with all of them below and choose one or more based on your program & location:
    TypeDomainDescription
    Primary Domainapi.goapi.aiThe most recommended domain for all api request
    Secondary Domainapi.goapi.xyzThe backup domain with all api endpoint available
    Special Domainproxy.goapi.xyzDomain that is improved for long wait response. If you have long halt GPT request, use this domain
    Modified at 2025-01-08 11:14:07
    Next
    Endpoints