Skip to main content
POST

Authorizations

Authorization
string
header
required

Provide the API key issued to you by your organization admin. Send it as Authorization: Bearer <api-key> on every request.

Body

application/json

Provide exactly one of coding_task_ids or generate.

candidate_email
string<email>
required

Candidate's email. Used as the interview attendee.

candidate_name
string
required

Candidate's full name. Used to build the interview title.

Minimum string length: 1

Public URL to the candidate's CV (PDF or DOCX).

qodeJobId
string
required

Job identifier returned by GET /jobs.

Minimum string length: 1
ai_assisted
boolean
default:false

Enable AI-assisted autocomplete in the candidate's coding IDE. Defaults to false (off).

coding_task_ids
string<uuid>[]

Explicit coding task ids to attach, in order. Mutually exclusive with generate.

generate
object

Random-generation spec. Mutually exclusive with coding_task_ids.

Response

Coding interview created. A candidate-facing link and the interview id are returned.

success
boolean
Example:

true

data
object