~/Documentation
Documentation

Authentification

Toutes les requêtes API nécessitent une authentification à l'aide d'un jeton Bearer.

Utilisation de votre clé API

Incluez votre clé API dans l'en-tête Authorization de chaque requête :

Authorization: Bearer ${RENDERFUL_API_KEY}

Developer API keys typically start with sk_ (legacy keys may start with vega_). Agent keys start with rf_.

Exemple de Requête

curl -X POST https://api.renderful.ai/api/v1/generations \
  -H "Authorization: Bearer ${RENDERFUL_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"type":"text-to-image","model":"flux-dev","prompt":"A sunset"}'

Bonnes Pratiques de Sécurité

  • Ne jamais exposer votre clé API dans du code côté client
  • Utiliser des variables d'environnement pour stocker votre clé
  • Faire pivoter les clés périodiquement
  • Utiliser des clés différentes pour le développement et la production

Balance endpoints by key type

Use the balance endpoint that matches the key prefix you are authenticating with.

Key TypePrefixBalance Endpoint
Developer API keysk_ / vega_GET /api/v1/account/balance
Agent API keyrf_GET /api/v1/agents/balance

Query developer balance

curl -X GET https://api.renderful.ai/api/v1/account/balance \
  -H "Authorization: Bearer sk_your_api_key"

Format de Clé API

Les clés API Renderful suivent un format spécifique pour une identification facile :

PréfixeDescription
sk_Developer API key for dashboard-created server-side integrations
vega_Legacy developer API key format still accepted for existing integrations
rf_Agent API key returned by POST /api/v1/agents/register