Documentação

Autenticação

Todas as requisições de API requerem autenticação usando um token Bearer.

Usando sua Chave de API

Inclua sua chave de API no cabeçalho Authorization de cada requisição:

Authorization: Bearer ${RENDERFUL_API_KEY}

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

Exemplo de Requisição

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

Melhores Práticas de Segurança

  • • Nunca exponha sua chave de API em código do lado do cliente
  • • Use variáveis de ambiente para armazenar sua chave
  • • Rotacione as chaves periodicamente
  • • Use chaves diferentes para desenvolvimento e produção

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"

Formato da Chave de API

As chaves de API do Renderful seguem um formato específico para fácil identificação:

PrefixoDescrição
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