`PUT` Add General Settings in an AI Interview¶

This API updates general settings for a specific AI interview.

Request URL¶

PUT /ai-interviews/settings/general/<ai_interview_id>

Body Parameters¶

{
    "general": {
        "cutoff": 6,
        "duration": {
            "min": 15,
            "max": 30
        },
        "mobile_friendly": true,
        "voice": ["american", "male"],
        "language": "English"
    }
}

Warning

Make sure to add your API key in the Header of the request using the key apiKey.

Parameters¶

Parameter	Type	Description
ai_interview_id	int	AI interview ID whose general settings should be updated.
cutoff	number	Interview cutoff score. Must be between 0 and 10.
duration	object	Interview duration configuration with min and max values.
mobile_friendly	boolean	Whether the interview can be taken on mobile devices.
voice	array	Interview voice as `[accent, gender]` (two strings). When set, must match the table below; invalid pairs return `400`
language	string	Preferred interview language. Must be one of the supported languages: English, Spanish, French, German, Italian, Portuguese, Russian, Dutch, Polish, Turkish, Vietnamese, Indonesian, Filipino, Malay, Arabic, Korean, Hebrew

Allowed `accent` and `gender` values (request body)¶

The first element is accent, the second is gender (male or female). Use the accent string exactly as in the first column; a ✓ marks a valid pair for that accent and gender.

accent	male	female
american	✓	✓
british	✓	✓
african_american	-	✓
arabic	✓	✓
australian	-	✓
indian	✓	✓

Response¶

{
    "status": "success",
    "message": "General settings updated successfully"
}