Armox
    Armox Academy 📚
    Referencia de APIIntroducción a la Referencia de API

    Introducción a la API

    La API Pública de Armox permite a los suscriptores elegibles ejecutar los mismos modelos y flujos de trabajo que potencian Armox Canvas, directamente desde tu backend, automatizaciones y herramientas internas.

    Usa esta página como punto de partida y luego consulta las páginas dedicadas de cada endpoint para referencias completas de solicitudes/respuestas y patrones de producción.


    Quién puede usar esta API

    El acceso a la API Pública está disponible para estos planes:

    • Agency
    • Master / Business
    • Enterprise

    El acceso a la API Pública no está disponible para los planes Free/Pro.

    URL Base

    Usa la URL base de producción de Armox para todos los endpoints:

    https://armox.ai/api/v1


    Autenticación

    Todos los endpoints de la API requieren una clave API Bearer en el encabezado Authorization:

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

    Gestiona las claves desde:

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

    Para la gestión completa de claves y prácticas de seguridad, consulta:


    Secciones de la API


    Inicio Rápido en 5 Pasos

    1. Crea una clave API en /app/settings/api-keys
    2. Llama a GET /api/v1/models para descubrir los IDs de modelos válidos y sus configuraciones
    3. Ejecuta un modelo con POST /api/v1/models/run
    4. Si la respuesta es asíncrona (status: "processing"), consulta GET /api/v1/jobs/:id
    5. Opcional: añade webhook_url para recibir eventos de finalización

    Tu Primera Solicitud

    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)
    }

    Próximos Pasos Comunes

    Conceptos Básicos de Seguridad

    • Mantén las claves API solo en el lado del servidor
    • Rota las claves regularmente
    • Usa claves separadas para desarrollo/staging/producción
    • Verifica las firmas de webhooks antes de procesar los payloads

    Notas de Producción

    • Persiste el job.id devuelto en tu base de datos
    • Consulta /jobs/:id o procesa eventos de webhook
    • Almacena las URLs de salida resultantes para la interfaz de tu aplicación

    ¿Listo para transformar tu flujo de trabajo creativo?

    No se requiere tarjeta de crédito2000 créditos gratis