Regenerate Response Policy

Configure how to charge users for regenerate responses (multiple API calls for the same request).

Overview

When users regenerate a response, multiple API calls are made for the same request. The Regenerate Response Policy allows you to control how these regenerates are charged.

Configuration Settings

Max Free Regenerates

Type: Integer (0 or higher)
Default: 0
Description: Number of free regenerates before charging users.

Example: If set to 2, the first 2 regenerates are free, and subsequent regenerates are charged.

Over Regenerate Multiplier

Type: Decimal (0.0 to 1.0)
Default: 1.0
Description: Multiplier applied to regenerates beyond the free limit.

How it works:

  • 1.0 = Charge full price (100%)
  • 0.5 = Charge half price (50% discount)
  • 0.2 = Charge 20% (80% discount)
  • 0.0 = Free (not recommended - use Max Free Regenerates instead)

Example Scenarios:

Scenario 1: Max Free = 2, Multiplier = 1.0 (Charge Full)

Request 1: Free ($0.00)
Request 2: Free ($0.00)
Request 3: Charge full ($1.00)
Request 4: Charge full ($1.00)
Request 5: Charge full ($1.00)
Total: $3.00

Scenario 2: Max Free = 2, Multiplier = 0.5 (50% Discount)

Request 1: Free ($0.00)
Request 2: Free ($0.00)
Request 3: Charge 50% ($0.50)
Request 4: Charge 50% ($0.50)
Request 5: Charge 50% ($0.50)
Total: $1.50

Scenario 3: Max Free = 2, Multiplier = 0.2 (80% Discount)

Request 1: Free ($0.00)
Request 2: Free ($0.00)
Request 3: Charge 20% ($0.20)
Request 4: Charge 20% ($0.20)
Request 5: Charge 20% ($0.20)
Total: $0.60

Abuse Threshold

Type: Integer (1 or higher)
Default: 10
Description: Number of regenerates before full charge (abuse detection).

How it works: When users exceed the abuse threshold, all subsequent regenerates are charged at full price (multiplier = 1.0), regardless of the Over Regenerate Multiplier setting.

Example: If Abuse Threshold = 10:

Request 1-2: Free (Max Free = 2)
Request 3-9: Discounted (Multiplier = 0.5)
Request 10+: Full charge (Abuse detection activated)

When to Use Each Setting

MultiplierUse CasePurpose
1.0Protect API costsCharge full price after free limit
0.5-0.8Balance UX and costsEncourage regenerates while still charging
0.1-0.3Strong engagementMaximize user engagement with heavy discount
0.0Not recommendedUse Max Free Regenerates instead

Best Practices

  1. Start Conservative: Begin with Max Free = 0 and Multiplier = 1.0 to protect your API costs.

  2. Monitor Usage: Track regenerate patterns to optimize your settings.

  3. Set Abuse Threshold: Always set an abuse threshold (default: 10) to prevent excessive API usage.

  4. Balance UX and Costs: Consider your API costs when setting the multiplier. Lower multipliers increase engagement but also increase costs.

Access Settings

Navigate to Settings > Params in your Hero dashboard, then go to the Reseller tab to configure these settings.

Related Documentation