Skip to main content

Credits Deduction

Credits are automatically deducted when a job is created. The deduction happens before the job is queued:
  • Credits Calculation: Credits deducted = Math.ceil(limit / 100)
    • Example: limit=100 → 1 credit, limit=200 → 2 credits, limit=300 → 3 credits
  • Credit Tier:
    • If enrich=true: Uses Pro Tier Credits (higherTierCreditsBalance)
    • If enrich=false: Uses Free Tier Credits (lowerTierCreditsBalance)
  • Insufficient Credits: If you don’t have enough credits, the request will fail with a 403 Forbidden error:
    {
      "error": "Insufficient credits"
    }
    

Important Notes

  • Credits are deducted immediately when a job is created (before queuing)
  • Credits required = Math.ceil(limit / 100) (e.g., limit 100 = 1 credit, limit 200 = 2 credits, limit 300 = 3 credits)
  • Pro Tier credits are used when enrich=true, Free Tier credits when enrich=false
  • Always check your credit balance using the Get User Credits endpoint before creating jobs
  • If job creation fails due to insufficient credits, no credits are deducted

Checking Your Credits

Use the Get User Credits endpoint to check your current credit balance:
curl -X GET "https://discover.veritus.ai/api/v1/user/getCredits" \
  -H "Authorization: Bearer YOUR_API_KEY"