************************************************************* ``POST`` Add/Update General Settings ************************************************************* This API updates global AI interview general settings. Request URL ============ .. code-block:: POST /ai-interviews/settings/general Body Parameters ================ .. code-block:: json { "general": { "cutoff": 6, "duration": { "min": 15, "max": 30 }, "mobile_friendly": true, "voice": ["american", "male"], "language": "English" }, "updateAll": true } .. warning:: Make sure to add your API key in the Header of the request using the key ``apiKey``. Parameters =========== +-------------------+------------+-----------------------------------------------------------------------+ | Parameter | Type | Description | +===================+============+=======================================================================+ | updateAll | boolean | If true, updates all existing AI interviews with these settings. | +-------------------+------------+-----------------------------------------------------------------------+ | cutoff | number | Interview cutoff score. Must be between 0 and 10. | +-------------------+------------+-----------------------------------------------------------------------+ | duration.min | number | Minimum interview duration in minutes. | +-------------------+------------+-----------------------------------------------------------------------+ | duration.max | number | Maximum interview duration in minutes (within plan limit). | +-------------------+------------+-----------------------------------------------------------------------+ | mobile_friendly | boolean | Whether the interview can be taken on mobile devices. | +-------------------+------------+-----------------------------------------------------------------------+ | voice | array | Interview voice as ``[accent, gender]`` (two strings). When set, the | | | | pair must appear in the table below. Invalid pairs return | | | | ``400`` with ``Invalid accent and gender combination.`` The value | | | | is stored as an internal voice identifier. ``pilot_id`` is ignored. | +-------------------+------------+-----------------------------------------------------------------------+ | language | string | Preferred interview language. Must be one of the supported languages. | | | | 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 ========= Successful ``POST`` returns the updated ``general`` object. The ``voice`` field in that response is the stored internal voice identifier (UUID string). ``GET`` on the same URL returns ``voice`` as a two-element array ``[accent, gender]`` (normalized from the stored identifier). .. code-block:: json { "general": { "cutoff": 6, "duration": { "min": 15, "max": 30 }, "mobile_friendly": true, "voice": "228fca29-3a0a-435c-8728-5cb483251068", "language": "English" } }