RF
RateFlow Developer Platform
Developer Reference

Simple API for voice rating pipelines

Authentication

All API requests require an x-api-key header.

x-api-key: CGview98!!
POST /api/v1/rate

Upload one audio file and receive a complete AI rating report. Supports MP3, WAV, OGG, MP4, WEBM, and M4A formats up to 15MB.

curl -X POST https://rate.scorpion.codes/api/v1/rate \
  -H "x-api-key: CGview98!!" \
  -F "audio=@candidate.mp3"
GET /api/v1/ratings

Get a paginated list of all ratings. Use query parameters for pagination and filtering.

curl -X GET "https://rate.scorpion.codes/api/v1/ratings?limit=10" \
  -H "x-api-key: CGview98!!"
GET /api/v1/stats

Get aggregate statistics including total ratings, average scores, and recommendation distribution.

curl -X GET https://rate.scorpion.codes/api/v1/stats \
  -H "x-api-key: CGview98!!"
DELETE /api/v1/ratings/:id

Delete a specific rating by ID. This action is irreversible.

curl -X DELETE https://rate.scorpion.codes/api/v1/ratings/123 \
  -H "x-api-key: CGview98!!"

Response Format

The rating endpoint returns a comprehensive assessment object.

{
  "success": true,
  "rating": {
    "overall_score": 8.2,
    "criteria": {
      "voice_clarity": 9,
      "language_proficiency": 8,
      "confidence_tone": 8,
      "communication_skills": 8,
      "energy_level": 8
    },
    "summary": "Strong candidate with excellent voice clarity...",
    "strengths": ["Clear pronunciation", "Professional tone"],
    "weaknesses": ["Could improve energy level"],
    "recommendation": "Recommended"
  }
}