Sign in

v1

latestOpenAPI 3.1.02026-08-0456127224.3 KB
Questions

Create a question

Creates a new question or criterion for a posting. The modality field determines the question type.

post/api/v2/postings/{posting_id}/questions

Path parameters

posting_idstring required

Headers

X-API-KEYstring nullable
Authorizationstring nullable
X-Workspace-Idstring nullable

Request body

modality'voice' | 'sms' | 'form' | 'resume_eligibility' | 'resume_scoring' | 'voice_tags' required

Question modality: voice, sms, form, resume_eligibility, resume_scoring, voice_tags.

textstring required

The question text, criterion text, or tag name.

evaluation_criteriastring nullable

Evaluation criteria.

score_of_1string nullable

Score-1 description.

score_of_5string nullable

Score-5 description.

score_weightinteger nullable

Importance weight for scoring (1–10).

not_scoredboolean nullable

Ask but don't score.

question_typestring nullable

Question format.

min_follow_upsinteger nullable

Min follow-ups.

max_follow_upsinteger nullable

Max follow-ups.

additional_instructionsstring nullable

Per-question instructions.

post_processing_evaluation_criteriastring nullable

Post-interview evaluation criteria.

expected_answerstring nullable

Expected answer (SMS).

expected_valueinteger nullable

Expected numeric value (SMS).

is_dealbreakerboolean nullable

Dealbreaker flag (SMS).

{"stackTrail":"components:schemas:CreateQuestionRequest:properties:answer:anyOf","oasType":"schema","type":"unknown","title":"Answer","description":"Expected answer (form).","nullable":true}
is_knockoutboolean nullable

Knockout flag (form).

dropdown_valuesobject[] nullable

Dropdown options.

is_answer_mandatedboolean nullable

Require answer (form).

mcq_typestring nullable

MCQ type (form).

operatorstring nullable

Validation operator (form).

file_typesstring[] nullable

Allowed file types (form).

allow_multiple_filesboolean nullable

Multiple files (form).

slider_minnumber nullable

Slider min (form).

slider_maxnumber nullable

Slider max (form).

slider_stepnumber nullable

Slider step (form).

response_format'text' | 'freeform' | 'date' | 'number' nullable

Response format for voice_tags: 'text', 'freeform', 'date', or 'number'.

instructionsstring nullable

Instructions (voice_tags).

optionsstring[] nullable

Options (voice_tags).

structured_configobject nullable

Advanced structured configuration (voice). Opaque key-value object forwarded to the AI interviewer.

Example request

{
  "modality": "voice",
  "text": "Tell me about a challenging project you led."
}

Response

Successful Response

metaobject nullable

Optional metadata. Shape varies by endpoint.

Example response

{
  "data": {
    "id": "A1B2C3D4",
    "posting_id": "13D77095",
    "modality": "voice",
    "text": "Tell me about a challenging project you led.",
    "rank": 1
  }
}