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

    Models Endpoint

    The Models API lets you:

    • discover available model IDs and settings
    • run one model execution per request

    Base path:

    • https://armox.ai/api/v1/models

    GET /api/v1/models

    Returns all available models and their configuration metadata.

    Request

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

    Response

    Prompt Template
    {
      "object": "list",
      "data": [
        {
          "id": "google/nano-banana",
          "name": "Nano Banana",
          "modality": "image",
          "cost": 70,
          "inputTypes": ["text", "image"],
          "promptRequired": true,
          "outputType": "image",
          "description": "Google image generation and editing model",
          "settings": [
            {
              "key": "aspect_ratio",
              "label": "Aspect Ratio",
              "inputType": "select",
              "defaultValue": "1:1"
            }
          ]
        }
      ]
    }

    POST /api/v1/models/run

    Runs one model generation.

    Request Body

    Prompt Template
    {
      "model": "google/nano-banana",
      "input": {
        "prompt": "string",
        "image_input": ["https://example.com/image.jpg"]
      },
      "webhook_url": "https://your-app.com/webhooks/armox"
    }

    Fields:

    • model (required): model ID from GET /api/v1/models
    • input (optional object): model-specific inputs and settings
    • webhook_url (optional): callback URL for completion events

    Synchronous vs Asynchronous Behavior

    POST /models/run can return either:

    • 200 for sync completion (typically image/text/tool outputs)
    • 202 for async processing (video/audio/3d outputs)

    Example: Image Model Run (Sync)

    Request

    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"
        }
      }'

    Typical 200 Response

    {
      "id": "a1b2c3d4-e5f6-7890-ab12-34567890abcd",
      "object": "job",
      "status": "completed",
      "model": "google/nano-banana",
      "output": {
        "outputImage": "https://storage.example.com/public/api-outputs/..."
      },
      "error": null,
      "credits_charged": 70,
      "created_at": "2026-03-26T12:00:00.000Z",
      "completed_at": "2026-03-26T12:00:03.000Z"
    }
    

    Example: Video Model Run (Async)

    Request

    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": "xai/grok-video-image-to-video",
        "input": {
          "prompt": "Animate this image with smooth camera movement and subtle environmental motion.",
          "image_input": "https://example.com/reference-image.jpg",
          "duration": 4
        }
      }'
    

    Typical 202 Response

    {
      "id": "f1e2d3c4-b5a6-7890-cd12-34567890efab",
      "object": "job",
      "status": "processing",
      "model": "xai/grok-video-image-to-video",
      "credits_charged": 202,
      "created_at": "2026-03-26T12:10:00.000Z"
    }
    

    Then poll:

    curl -X GET "https://armox.ai/api/v1/jobs/f1e2d3c4-b5a6-7890-cd12-34567890efab" \
      -H "Authorization: Bearer sk_live_your_key_here"
    

    JavaScript Example

    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: "High-end product photo on clean white background",
        },
      }),
    });
    
    const job = await response.json();
    console.log(job);
    

    Python Example

    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": "High-end product photo on clean white background"},
        },
    )
    
    print(response.status_code)
    print(response.json())
    

    Errors You Should Handle

    • 400 invalid payload or invalid model
    • 401 missing/invalid API key
    • 402 insufficient credits
    • 403 access restricted by subscription
    • 429 rate limit exceeded

    See full details: Errors & Rate Limits

    Related Pages

    • Jobs Endpoint
    • Webhooks
    • API Reference Introduction
    上一页身份验证
    下一页应用端点

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

    无需信用卡500免费积分

    本页内容

    GET `/api/v1/models`RequestResponsePOST `/api/v1/models/run`Request BodySynchronous vs Asynchronous BehaviorExample: Image Model Run (Sync)RequestTypical `200` ResponseExample: Video Model Run (Async)RequestTypical `202` ResponseJavaScript ExamplePython ExampleErrors You Should HandleRelated Pages