Introduction à la référence API
L'API publique Armox permet aux abonnés éligibles d'exécuter les mêmes modèles et workflows applicatifs qui alimentent Armox Canvas, directement depuis votre backend, vos automatisations et vos outils internes.
Utilisez cette page comme point de départ, puis consultez les pages dédiées à chaque endpoint pour les références complètes de requêtes/réponses et les bonnes pratiques en production.
Qui peut utiliser cette API
L'accès à l'API publique est disponible pour les plans suivants :
- Agency
- Master / Business
- Enterprise
L'accès à l'API publique n'est pas disponible pour les plans Free/Pro.
URL de base
Utilisez l'URL de base de l'API de production Armox pour tous les endpoints :
https://armox.ai/api/v1
Authentification
Tous les endpoints de l'API nécessitent une clé API Bearer dans l'en-tête Authorization :
curl -X GET "https://armox.ai/api/v1/models" \
-H "Authorization: Bearer sk_live_your_key_here"
Gérez vos clés depuis :
https://armox.ai/app/settings/api-keys
Pour la gestion complète des clés et les bonnes pratiques de sécurité, consultez :
Sections de l'API
- Authentification
- Endpoint Models
- Endpoint Apps
- Endpoint Jobs
- Endpoint Account
- Webhooks
- Erreurs et limites de débit
Démarrage rapide en 5 étapes
- Créez une clé API dans
/app/settings/api-keys - Appelez
GET /api/v1/modelspour découvrir les identifiants de modèles valides et leurs paramètres - Exécutez un modèle avec
POST /api/v1/models/run - Si la réponse est asynchrone (
status: "processing"), interrogezGET /api/v1/jobs/:id - Optionnel : ajoutez
webhook_urlpour recevoir les événements de complétion
Votre première requête
cURL
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)
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
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
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) }
Prochaines étapes courantes
- Apprendre l'authentification et la sécurité des clés : Authentification
- Comprendre les exécutions de modèles synchrones/asynchrones : Endpoint Models
- Construire des automatisations de workflows applicatifs : Endpoint Apps
- Implémenter le polling et l'annulation : Endpoint Jobs
- Configurer les webhooks en production : Webhooks
- Gérer les erreurs et les tentatives après un 429 : Erreurs et limites de débit
Bases de sécurité
- Conservez les clés API uniquement côté serveur
- Effectuez une rotation régulière des clés
- Utilisez des clés distinctes pour le développement, le staging et la production
- Vérifiez les signatures des webhooks avant de traiter les payloads
Notes pour la production
- Persistez le
job.idretourné dans votre base de données - Interrogez
/jobs/:idou traitez les événements webhook - Stockez les URLs de sortie résultantes pour l'interface de votre application