BLACKFRIDAY 来了!

    领取40%优惠
    Armox
    Armox Academy 📚
    介绍
    快速入门指南
    理解Brain
    节点
    AI模型
    画布编辑器
    训练 LoRA
    Train MiniMax H3 LoRA
    提示词工程
    Nano Banana ProFlux模型视频提示词音频提示词
    文本节点
    图像节点
    视频节点
    音频节点
    上传节点
    工具节点
    Academy.canvas3dNodes
    连接节点
    运行工作流
    什么是应用?
    创建您的第一个应用
    运行应用
    创意人士的应用创意
    API 参考入门
    身份验证模型端点应用端点任务端点账户端点Webhook错误与速率限制
    图库
    下载与导出
    使用AI聊天
    与AI进行头脑风暴
    文本模型
    GPT-5.4Gemini 3.1 ProClaude Opus 4.6GPT-5Gemini 2.5 FlashClaude 4.5 SonnetDeepSeek V3.1Grok 4Llama 3 70BLlama 3 8B
    图像模型
    Nano BananaNano Banana 2Nano Banana ProGPT Image 2.5Flux 2 ProKrea 2 LargeKrea 2 MediumFlux 2 FlexFlux 2 DevFlux 1.1 Pro UltraGrok ImagineFlux Kontext MaxFlux Kontext ProSeedream 4Seedream 4.5Wan 2.2 ImageQwen ImageQwen Image Edit AnglesStable Diffusion XLGrok 2 ImageGen4 Image
    视频模型
    Kling V2.5 Turbo ProKling 2.6 ProGrok VideoVeo 3.1Veo 3.1 FastSeedance 1 ProSeedance 1 Pro FastSeedance 1 LiteSeedance 2.0Wan 2.6 I2VWan 2.6 T2VWan 2.5 I2VWan 2.5 T2VSora 2 ProSora 2Hailuo 2.3Hailuo 2.3 FastVideo-01 DirectorGen4 Aleph
    音频模型
    MusicGenMusic 1.5Music-01Lyria 2Speech-02 TurboSpeech-02 HDVoice CloningXTTS-v2
    工具模型
    Topaz Image UpscalerPrunaAI UpscaleCrystal UpscalerRemove BackgroundFace SwapImage FiltersProfessional HeadshotText RemovalInpaintAdd WatermarkVideo Upscale (Runway)Video Upscale (Topaz)Video Upscale (Bytedance)Lip Sync ProAuto CaptionReplace CharacterMotion Transfer
    Academy.models3d
    Hunyuan3D V3
    社交媒体内容
    产品摄影
    营销活动
    视频制作
    音频与音乐
    多步骤工作流
    图像到图像
    一致风格
    积分优化
    常见错误
    键盘快捷键
    示例画廊
    提示词库
    Seedance 2.0 for AEC
    企业版概述
    管理员控制台
    申请积分
    常见问题
    理解积分
    故障排除
    API 参考API 参考入门
    Copy to LLM

    API Reference Introduction

    The Armox Public API lets all users run the same models and app workflows that power Armox Canvas, directly from your backend, automations, and internal tools.

    Use this page as your starting point, then go to the dedicated endpoint pages for full request/response references and production patterns.


    Who Can Use This API

    Public API access is available on every plan, including Free, Hobby, Pro, Ultra, legacy Agency and Master, Business, and Enterprise. A valid API key is required. Generation uses your account credits and plan limits.

    Base URL

    Use the Armox production API base URL for all endpoints:

    https://armox.ai/api/v1


    Authentication

    All API endpoints require a Bearer API key in the Authorization header:

    curl -X GET "https://armox.ai/api/v1/models" \
      -H "Authorization: Bearer sk_live_your_key_here"
    

    Manage keys from:

    • https://armox.ai/app/settings/api-keys

    For full key management and security practices, see:

    • Authentication

    API Sections

    • Authentication
    • Models Endpoint
    • Apps Endpoint
    • Jobs Endpoint
    • Account Endpoint
    • Webhooks
    • Errors & Rate Limits

    Quick Start in 5 Steps

    1. Create an API key in /app/settings/api-keys
    2. Call GET /api/v1/models to discover valid model IDs and settings
    3. Run a model with POST /api/v1/models/run
    4. If response is async (status: "processing"), poll GET /api/v1/jobs/:id
    5. Optional: add webhook_url to receive completion events

    Your First Request

    cURL

    Prompt Template
    curl -X POST "https://armox.ai/api/v1/models/run" \
      -H "Authorization: Bearer sk_live_your_key_here" \
      -H "Content-Type: application/json" \
      -d '{
        "model": "google/nano-banana",
        "input": {
          "prompt": "Turn this into a cinematic night street photo with neon signs and reflections.",
          "image_input": ["https://example.com/reference-image.jpg"],
          "aspect_ratio": "match_input_image",
          "output_format": "png"
        }
      }'

    JavaScript (fetch)

    Prompt Template
    const response = await fetch("https://armox.ai/api/v1/models/run", {
      method: "POST",
      headers: {
        Authorization: "Bearer sk_live_your_key_here",
        "Content-Type": "application/json",
      },
      body: JSON.stringify({
        model: "google/nano-banana",
        input: {
          prompt: "Turn this into a cinematic night street photo with neon signs and reflections.",
          image_input: ["https://example.com/reference-image.jpg"],
          aspect_ratio: "match_input_image",
          output_format: "png",
        },
      }),
    });
    
    const data = await response.json();
    console.log(data);

    Python

    Prompt Template
    import requests
    
    response = requests.post(
        "https://armox.ai/api/v1/models/run",
        headers={
            "Authorization": "Bearer sk_live_your_key_here",
            "Content-Type": "application/json",
        },
        json={
            "model": "google/nano-banana",
            "input": {
                "prompt": "Turn this into a cinematic night street photo with neon signs and reflections.",
                "image_input": ["https://example.com/reference-image.jpg"],
                "aspect_ratio": "match_input_image",
                "output_format": "png",
            },
        },
    )
    
    print(response.status_code)
    print(response.json())

    Go

    Prompt Template
    package main
    
    import (
      "bytes"
      "encoding/json"
      "fmt"
      "net/http"
    )
    
    func main() {
      payload := map[string]any{
        "model": "google/nano-banana",
        "input": map[string]any{
          "prompt": "Turn this into a cinematic night street photo with neon signs and reflections.",
          "image_input": []string{"https://example.com/reference-image.jpg"},
          "aspect_ratio": "match_input_image",
          "output_format": "png",
        },
      }
    
      b, _ := json.Marshal(payload)
      req, _ := http.NewRequest("POST", "https://armox.ai/api/v1/models/run", bytes.NewBuffer(b))
      req.Header.Set("Authorization", "Bearer sk_live_your_key_here")
      req.Header.Set("Content-Type", "application/json")
    
      client := &http.Client{}
      resp, _ := client.Do(req)
      defer resp.Body.Close()
    
      fmt.Println("Status:", resp.StatusCode)
    }

    Common Next Steps

    • Learn auth and key safety: Authentication
    • Understand sync/async model runs: Models Endpoint
    • Build app workflow automations: Apps Endpoint
    • Implement polling and cancellation: Jobs Endpoint
    • Configure production webhooks: Webhooks
    • Handle errors and 429 retries: Errors & Rate Limits

    Security Basics

    • Keep API keys server-side only
    • Rotate keys regularly
    • Use separate keys for dev/staging/production
    • Verify webhook signatures before processing payloads

    Production Notes

    • Persist returned job.id in your database
    • Either poll /jobs/:id or process webhook events
    • Store resulting output URLs for your app UI
    上一页创意人士的应用创意
    下一页身份验证

    准备好转变 您的创意工作流了吗?

    无需信用卡500免费积分

    本页内容

    Who Can Use This APIBase URLAuthenticationAPI SectionsQuick Start in 5 StepsYour First RequestcURLJavaScript (fetch)PythonGoCommon Next StepsSecurity BasicsProduction Notes