~/Documentation
Dokumentation

Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung mit einem Bearer-Token.

Verwendung Ihres API-Schlüssels

Fügen Sie Ihren API-Schlüssel in den Authorization-Header jeder Anfrage ein:

Authorization: Bearer ${RENDERFUL_API_KEY}

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

Beispielanfrage

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

Sicherheits-Best-Practices

  • Legen Sie Ihren API-Schlüssel niemals in clientseitigem Code offen
  • Verwenden Sie Umgebungsvariablen zum Speichern Ihres Schlüssels
  • Rotieren Sie Schlüssel regelmäßig
  • Verwenden Sie unterschiedliche Schlüssel für Entwicklung und Produktion

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"

API-Schlüssel-Format

Renderful API-Schlüssel folgen einem spezifischen Format zur einfachen Identifizierung:

PräfixBeschreibung
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