文档

身份验证

所有 API 请求都需要使用 Bearer 令牌进行身份验证。

使用您的 API 密钥

在每个请求的 Authorization 头中包含您的 API 密钥:

Authorization: Bearer ${RENDERFUL_API_KEY}

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

示例请求

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

安全最佳实践

  • 切勿在客户端代码中暴露您的 API 密钥
  • 使用环境变量存储您的密钥
  • 定期轮换密钥
  • 为开发和生产环境使用不同的密钥

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 密钥格式

Renderful API 密钥遵循特定格式以便识别:

前缀描述
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