Begin a spoken interview with one of your end-users, or hand back one they have not finished with.
Changed onStarts an interview and returns its first question as both text and a playable audio URL. Pick the question set with template_key; the whole interview — every question and the final write-up — is produced in the language you send as preferred_language. If this user already has an unfinished interview on the same clone, it is resumed instead of restarted and is_resumed is true, so a person who closed your app halfway through picks up where they stopped. If instead they finished one recently and never asked for the write-up, that session is handed back: is_complete is true, there is no question, and interview_session_id is the one to pass to generate_voice_interview_report. Neither case counts against the daily limit, because neither starts an interview. Hold on to interview_session_id: every later call needs it.
Request
- Base URL: https://partner.mindupload.app
- URL: https://partner.mindupload.app/v1/start_voice_interview
- Auth: API key in header X-Partner-Key
Request body
Response
Result envelope — check the success field.
Changes
- warning
added the new
safety_pausedenum value to theresponse property for the response status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- warning