Create a question

Create a question

curl --request POST \
  --url https://api.heymilo.ai/api/v2/postings/{posting_id}/questions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "modality": "voice",
  "text": "Tell me about a challenging project you led.",
  "evaluation_criteria": "<string>",
  "score_of_1": "<string>",
  "score_of_5": "<string>",
  "score_weight": 5,
  "not_scored": true,
  "question_type": "<string>",
  "min_follow_ups": 1,
  "max_follow_ups": 1,
  "additional_instructions": "<string>",
  "post_processing_evaluation_criteria": "<string>",
  "expected_answer": "<string>",
  "expected_value": 123,
  "is_dealbreaker": true,
  "answer": "<unknown>",
  "is_knockout": true,
  "dropdown_values": [
    {}
  ],
  "is_answer_mandated": true,
  "mcq_type": "<string>",
  "operator": "<string>",
  "file_types": [
    "<string>"
  ],
  "allow_multiple_files": true,
  "slider_min": 123,
  "slider_max": 123,
  "slider_step": 123,
  "instructions": "<string>",
  "options": [
    "<string>"
  ],
  "structured_config": {}
}
'

import requests

url = "https://api.heymilo.ai/api/v2/postings/{posting_id}/questions"

payload = {
    "modality": "voice",
    "text": "Tell me about a challenging project you led.",
    "evaluation_criteria": "<string>",
    "score_of_1": "<string>",
    "score_of_5": "<string>",
    "score_weight": 5,
    "not_scored": True,
    "question_type": "<string>",
    "min_follow_ups": 1,
    "max_follow_ups": 1,
    "additional_instructions": "<string>",
    "post_processing_evaluation_criteria": "<string>",
    "expected_answer": "<string>",
    "expected_value": 123,
    "is_dealbreaker": True,
    "answer": "<unknown>",
    "is_knockout": True,
    "dropdown_values": [{}],
    "is_answer_mandated": True,
    "mcq_type": "<string>",
    "operator": "<string>",
    "file_types": ["<string>"],
    "allow_multiple_files": True,
    "slider_min": 123,
    "slider_max": 123,
    "slider_step": 123,
    "instructions": "<string>",
    "options": ["<string>"],
    "structured_config": {}
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    modality: 'voice',
    text: 'Tell me about a challenging project you led.',
    evaluation_criteria: '<string>',
    score_of_1: '<string>',
    score_of_5: '<string>',
    score_weight: 5,
    not_scored: true,
    question_type: '<string>',
    min_follow_ups: 1,
    max_follow_ups: 1,
    additional_instructions: '<string>',
    post_processing_evaluation_criteria: '<string>',
    expected_answer: '<string>',
    expected_value: 123,
    is_dealbreaker: true,
    answer: '<unknown>',
    is_knockout: true,
    dropdown_values: [{}],
    is_answer_mandated: true,
    mcq_type: '<string>',
    operator: '<string>',
    file_types: ['<string>'],
    allow_multiple_files: true,
    slider_min: 123,
    slider_max: 123,
    slider_step: 123,
    instructions: '<string>',
    options: ['<string>'],
    structured_config: {}
  })
};

fetch('https://api.heymilo.ai/api/v2/postings/{posting_id}/questions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heymilo.ai/api/v2/postings/{posting_id}/questions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'modality' => 'voice',
    'text' => 'Tell me about a challenging project you led.',
    'evaluation_criteria' => '<string>',
    'score_of_1' => '<string>',
    'score_of_5' => '<string>',
    'score_weight' => 5,
    'not_scored' => true,
    'question_type' => '<string>',
    'min_follow_ups' => 1,
    'max_follow_ups' => 1,
    'additional_instructions' => '<string>',
    'post_processing_evaluation_criteria' => '<string>',
    'expected_answer' => '<string>',
    'expected_value' => 123,
    'is_dealbreaker' => true,
    'answer' => '<unknown>',
    'is_knockout' => true,
    'dropdown_values' => [
        [
                
        ]
    ],
    'is_answer_mandated' => true,
    'mcq_type' => '<string>',
    'operator' => '<string>',
    'file_types' => [
        '<string>'
    ],
    'allow_multiple_files' => true,
    'slider_min' => 123,
    'slider_max' => 123,
    'slider_step' => 123,
    'instructions' => '<string>',
    'options' => [
        '<string>'
    ],
    'structured_config' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.heymilo.ai/api/v2/postings/{posting_id}/questions"

	payload := strings.NewReader("{\n  \"modality\": \"voice\",\n  \"text\": \"Tell me about a challenging project you led.\",\n  \"evaluation_criteria\": \"<string>\",\n  \"score_of_1\": \"<string>\",\n  \"score_of_5\": \"<string>\",\n  \"score_weight\": 5,\n  \"not_scored\": true,\n  \"question_type\": \"<string>\",\n  \"min_follow_ups\": 1,\n  \"max_follow_ups\": 1,\n  \"additional_instructions\": \"<string>\",\n  \"post_processing_evaluation_criteria\": \"<string>\",\n  \"expected_answer\": \"<string>\",\n  \"expected_value\": 123,\n  \"is_dealbreaker\": true,\n  \"answer\": \"<unknown>\",\n  \"is_knockout\": true,\n  \"dropdown_values\": [\n    {}\n  ],\n  \"is_answer_mandated\": true,\n  \"mcq_type\": \"<string>\",\n  \"operator\": \"<string>\",\n  \"file_types\": [\n    \"<string>\"\n  ],\n  \"allow_multiple_files\": true,\n  \"slider_min\": 123,\n  \"slider_max\": 123,\n  \"slider_step\": 123,\n  \"instructions\": \"<string>\",\n  \"options\": [\n    \"<string>\"\n  ],\n  \"structured_config\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.heymilo.ai/api/v2/postings/{posting_id}/questions")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"modality\": \"voice\",\n  \"text\": \"Tell me about a challenging project you led.\",\n  \"evaluation_criteria\": \"<string>\",\n  \"score_of_1\": \"<string>\",\n  \"score_of_5\": \"<string>\",\n  \"score_weight\": 5,\n  \"not_scored\": true,\n  \"question_type\": \"<string>\",\n  \"min_follow_ups\": 1,\n  \"max_follow_ups\": 1,\n  \"additional_instructions\": \"<string>\",\n  \"post_processing_evaluation_criteria\": \"<string>\",\n  \"expected_answer\": \"<string>\",\n  \"expected_value\": 123,\n  \"is_dealbreaker\": true,\n  \"answer\": \"<unknown>\",\n  \"is_knockout\": true,\n  \"dropdown_values\": [\n    {}\n  ],\n  \"is_answer_mandated\": true,\n  \"mcq_type\": \"<string>\",\n  \"operator\": \"<string>\",\n  \"file_types\": [\n    \"<string>\"\n  ],\n  \"allow_multiple_files\": true,\n  \"slider_min\": 123,\n  \"slider_max\": 123,\n  \"slider_step\": 123,\n  \"instructions\": \"<string>\",\n  \"options\": [\n    \"<string>\"\n  ],\n  \"structured_config\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heymilo.ai/api/v2/postings/{posting_id}/questions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"modality\": \"voice\",\n  \"text\": \"Tell me about a challenging project you led.\",\n  \"evaluation_criteria\": \"<string>\",\n  \"score_of_1\": \"<string>\",\n  \"score_of_5\": \"<string>\",\n  \"score_weight\": 5,\n  \"not_scored\": true,\n  \"question_type\": \"<string>\",\n  \"min_follow_ups\": 1,\n  \"max_follow_ups\": 1,\n  \"additional_instructions\": \"<string>\",\n  \"post_processing_evaluation_criteria\": \"<string>\",\n  \"expected_answer\": \"<string>\",\n  \"expected_value\": 123,\n  \"is_dealbreaker\": true,\n  \"answer\": \"<unknown>\",\n  \"is_knockout\": true,\n  \"dropdown_values\": [\n    {}\n  ],\n  \"is_answer_mandated\": true,\n  \"mcq_type\": \"<string>\",\n  \"operator\": \"<string>\",\n  \"file_types\": [\n    \"<string>\"\n  ],\n  \"allow_multiple_files\": true,\n  \"slider_min\": 123,\n  \"slider_max\": 123,\n  \"slider_step\": 123,\n  \"instructions\": \"<string>\",\n  \"options\": [\n    \"<string>\"\n  ],\n  \"structured_config\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "A1B2C3D4",
    "posting_id": "13D77095",
    "modality": "voice",
    "text": "Tell me about a challenging project you led.",
    "object": "question",
    "rank": 1,
    "evaluation_criteria": "<string>",
    "score_of_1": "<string>",
    "score_of_5": "<string>",
    "score_weight": 123,
    "not_scored": true,
    "question_type": "<string>",
    "min_follow_ups": 123,
    "max_follow_ups": 123,
    "additional_instructions": "<string>",
    "post_processing_evaluation_criteria": "<string>",
    "expected_answer": "<string>",
    "expected_value": 123,
    "is_dealbreaker": true,
    "answer": "<unknown>",
    "is_knockout": true,
    "dropdown_values": [
      {}
    ],
    "is_answer_mandated": true,
    "mcq_type": "<string>",
    "operator": "<string>",
    "file_types": [
      "<string>"
    ],
    "allow_multiple_files": true,
    "slider_min": 123,
    "slider_max": 123,
    "slider_step": 123,
    "response_format": "text",
    "instructions": "<string>",
    "options": [
      "<string>"
    ],
    "structured_config": {},
    "created_at": 123,
    "updated_at": 123
  },
  "meta": {}
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "validation_error",
    "message": "The request body failed validation",
    "param": "<string>",
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_param",
        "message": "title must be between 3 and 200 characters",
        "param": "title"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "validation_error",
    "message": "The request body failed validation",
    "param": "<string>",
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_param",
        "message": "title must be between 3 and 200 characters",
        "param": "title"
      }
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "validation_error",
    "message": "The request body failed validation",
    "param": "<string>",
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_param",
        "message": "title must be between 3 and 200 characters",
        "param": "title"
      }
    ]
  }
}

POST

api

postings

{posting_id}

questions

Create a question

curl --request POST \
  --url https://api.heymilo.ai/api/v2/postings/{posting_id}/questions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "modality": "voice",
  "text": "Tell me about a challenging project you led.",
  "evaluation_criteria": "<string>",
  "score_of_1": "<string>",
  "score_of_5": "<string>",
  "score_weight": 5,
  "not_scored": true,
  "question_type": "<string>",
  "min_follow_ups": 1,
  "max_follow_ups": 1,
  "additional_instructions": "<string>",
  "post_processing_evaluation_criteria": "<string>",
  "expected_answer": "<string>",
  "expected_value": 123,
  "is_dealbreaker": true,
  "answer": "<unknown>",
  "is_knockout": true,
  "dropdown_values": [
    {}
  ],
  "is_answer_mandated": true,
  "mcq_type": "<string>",
  "operator": "<string>",
  "file_types": [
    "<string>"
  ],
  "allow_multiple_files": true,
  "slider_min": 123,
  "slider_max": 123,
  "slider_step": 123,
  "instructions": "<string>",
  "options": [
    "<string>"
  ],
  "structured_config": {}
}
'

import requests

url = "https://api.heymilo.ai/api/v2/postings/{posting_id}/questions"

payload = {
    "modality": "voice",
    "text": "Tell me about a challenging project you led.",
    "evaluation_criteria": "<string>",
    "score_of_1": "<string>",
    "score_of_5": "<string>",
    "score_weight": 5,
    "not_scored": True,
    "question_type": "<string>",
    "min_follow_ups": 1,
    "max_follow_ups": 1,
    "additional_instructions": "<string>",
    "post_processing_evaluation_criteria": "<string>",
    "expected_answer": "<string>",
    "expected_value": 123,
    "is_dealbreaker": True,
    "answer": "<unknown>",
    "is_knockout": True,
    "dropdown_values": [{}],
    "is_answer_mandated": True,
    "mcq_type": "<string>",
    "operator": "<string>",
    "file_types": ["<string>"],
    "allow_multiple_files": True,
    "slider_min": 123,
    "slider_max": 123,
    "slider_step": 123,
    "instructions": "<string>",
    "options": ["<string>"],
    "structured_config": {}
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    modality: 'voice',
    text: 'Tell me about a challenging project you led.',
    evaluation_criteria: '<string>',
    score_of_1: '<string>',
    score_of_5: '<string>',
    score_weight: 5,
    not_scored: true,
    question_type: '<string>',
    min_follow_ups: 1,
    max_follow_ups: 1,
    additional_instructions: '<string>',
    post_processing_evaluation_criteria: '<string>',
    expected_answer: '<string>',
    expected_value: 123,
    is_dealbreaker: true,
    answer: '<unknown>',
    is_knockout: true,
    dropdown_values: [{}],
    is_answer_mandated: true,
    mcq_type: '<string>',
    operator: '<string>',
    file_types: ['<string>'],
    allow_multiple_files: true,
    slider_min: 123,
    slider_max: 123,
    slider_step: 123,
    instructions: '<string>',
    options: ['<string>'],
    structured_config: {}
  })
};

fetch('https://api.heymilo.ai/api/v2/postings/{posting_id}/questions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heymilo.ai/api/v2/postings/{posting_id}/questions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'modality' => 'voice',
    'text' => 'Tell me about a challenging project you led.',
    'evaluation_criteria' => '<string>',
    'score_of_1' => '<string>',
    'score_of_5' => '<string>',
    'score_weight' => 5,
    'not_scored' => true,
    'question_type' => '<string>',
    'min_follow_ups' => 1,
    'max_follow_ups' => 1,
    'additional_instructions' => '<string>',
    'post_processing_evaluation_criteria' => '<string>',
    'expected_answer' => '<string>',
    'expected_value' => 123,
    'is_dealbreaker' => true,
    'answer' => '<unknown>',
    'is_knockout' => true,
    'dropdown_values' => [
        [
                
        ]
    ],
    'is_answer_mandated' => true,
    'mcq_type' => '<string>',
    'operator' => '<string>',
    'file_types' => [
        '<string>'
    ],
    'allow_multiple_files' => true,
    'slider_min' => 123,
    'slider_max' => 123,
    'slider_step' => 123,
    'instructions' => '<string>',
    'options' => [
        '<string>'
    ],
    'structured_config' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.heymilo.ai/api/v2/postings/{posting_id}/questions"

	payload := strings.NewReader("{\n  \"modality\": \"voice\",\n  \"text\": \"Tell me about a challenging project you led.\",\n  \"evaluation_criteria\": \"<string>\",\n  \"score_of_1\": \"<string>\",\n  \"score_of_5\": \"<string>\",\n  \"score_weight\": 5,\n  \"not_scored\": true,\n  \"question_type\": \"<string>\",\n  \"min_follow_ups\": 1,\n  \"max_follow_ups\": 1,\n  \"additional_instructions\": \"<string>\",\n  \"post_processing_evaluation_criteria\": \"<string>\",\n  \"expected_answer\": \"<string>\",\n  \"expected_value\": 123,\n  \"is_dealbreaker\": true,\n  \"answer\": \"<unknown>\",\n  \"is_knockout\": true,\n  \"dropdown_values\": [\n    {}\n  ],\n  \"is_answer_mandated\": true,\n  \"mcq_type\": \"<string>\",\n  \"operator\": \"<string>\",\n  \"file_types\": [\n    \"<string>\"\n  ],\n  \"allow_multiple_files\": true,\n  \"slider_min\": 123,\n  \"slider_max\": 123,\n  \"slider_step\": 123,\n  \"instructions\": \"<string>\",\n  \"options\": [\n    \"<string>\"\n  ],\n  \"structured_config\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.heymilo.ai/api/v2/postings/{posting_id}/questions")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"modality\": \"voice\",\n  \"text\": \"Tell me about a challenging project you led.\",\n  \"evaluation_criteria\": \"<string>\",\n  \"score_of_1\": \"<string>\",\n  \"score_of_5\": \"<string>\",\n  \"score_weight\": 5,\n  \"not_scored\": true,\n  \"question_type\": \"<string>\",\n  \"min_follow_ups\": 1,\n  \"max_follow_ups\": 1,\n  \"additional_instructions\": \"<string>\",\n  \"post_processing_evaluation_criteria\": \"<string>\",\n  \"expected_answer\": \"<string>\",\n  \"expected_value\": 123,\n  \"is_dealbreaker\": true,\n  \"answer\": \"<unknown>\",\n  \"is_knockout\": true,\n  \"dropdown_values\": [\n    {}\n  ],\n  \"is_answer_mandated\": true,\n  \"mcq_type\": \"<string>\",\n  \"operator\": \"<string>\",\n  \"file_types\": [\n    \"<string>\"\n  ],\n  \"allow_multiple_files\": true,\n  \"slider_min\": 123,\n  \"slider_max\": 123,\n  \"slider_step\": 123,\n  \"instructions\": \"<string>\",\n  \"options\": [\n    \"<string>\"\n  ],\n  \"structured_config\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heymilo.ai/api/v2/postings/{posting_id}/questions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"modality\": \"voice\",\n  \"text\": \"Tell me about a challenging project you led.\",\n  \"evaluation_criteria\": \"<string>\",\n  \"score_of_1\": \"<string>\",\n  \"score_of_5\": \"<string>\",\n  \"score_weight\": 5,\n  \"not_scored\": true,\n  \"question_type\": \"<string>\",\n  \"min_follow_ups\": 1,\n  \"max_follow_ups\": 1,\n  \"additional_instructions\": \"<string>\",\n  \"post_processing_evaluation_criteria\": \"<string>\",\n  \"expected_answer\": \"<string>\",\n  \"expected_value\": 123,\n  \"is_dealbreaker\": true,\n  \"answer\": \"<unknown>\",\n  \"is_knockout\": true,\n  \"dropdown_values\": [\n    {}\n  ],\n  \"is_answer_mandated\": true,\n  \"mcq_type\": \"<string>\",\n  \"operator\": \"<string>\",\n  \"file_types\": [\n    \"<string>\"\n  ],\n  \"allow_multiple_files\": true,\n  \"slider_min\": 123,\n  \"slider_max\": 123,\n  \"slider_step\": 123,\n  \"instructions\": \"<string>\",\n  \"options\": [\n    \"<string>\"\n  ],\n  \"structured_config\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "A1B2C3D4",
    "posting_id": "13D77095",
    "modality": "voice",
    "text": "Tell me about a challenging project you led.",
    "object": "question",
    "rank": 1,
    "evaluation_criteria": "<string>",
    "score_of_1": "<string>",
    "score_of_5": "<string>",
    "score_weight": 123,
    "not_scored": true,
    "question_type": "<string>",
    "min_follow_ups": 123,
    "max_follow_ups": 123,
    "additional_instructions": "<string>",
    "post_processing_evaluation_criteria": "<string>",
    "expected_answer": "<string>",
    "expected_value": 123,
    "is_dealbreaker": true,
    "answer": "<unknown>",
    "is_knockout": true,
    "dropdown_values": [
      {}
    ],
    "is_answer_mandated": true,
    "mcq_type": "<string>",
    "operator": "<string>",
    "file_types": [
      "<string>"
    ],
    "allow_multiple_files": true,
    "slider_min": 123,
    "slider_max": 123,
    "slider_step": 123,
    "response_format": "text",
    "instructions": "<string>",
    "options": [
      "<string>"
    ],
    "structured_config": {},
    "created_at": 123,
    "updated_at": 123
  },
  "meta": {}
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "validation_error",
    "message": "The request body failed validation",
    "param": "<string>",
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_param",
        "message": "title must be between 3 and 200 characters",
        "param": "title"
      }
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "validation_error",
    "message": "The request body failed validation",
    "param": "<string>",
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_param",
        "message": "title must be between 3 and 200 characters",
        "param": "title"
      }
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "validation_error",
    "message": "The request body failed validation",
    "param": "<string>",
    "doc_url": "<string>",
    "errors": [
      {
        "code": "invalid_param",
        "message": "title must be between 3 and 200 characters",
        "param": "title"
      }
    ]
  }
}

Authorizations

X-API-KEY

string

header

required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

X-API-KEY

string | null

Authorization

string | null

X-Workspace-Id

string | null

Path Parameters

posting_id

string

required

Body

application/json

Request body for creating a new question or criterion.

The modality field determines the question type. Only fields relevant to the chosen modality need to be provided.

modality

enum<string>

required

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

Available options:

voice,

sms,

form,

resume_eligibility,

resume_scoring,

voice_tags

Example:

"voice"

text

string

required

The question text, criterion text, or tag name.

Example:

"Tell me about a challenging project you led."

evaluation_criteria

string | null

Evaluation criteria.

score_of_1

string | null

Score-1 description.

score_of_5

string | null

Score-5 description.

score_weight

integer | null

Importance weight for scoring (1–10).

Required range: 1 <= x <= 10

not_scored

boolean | null

Ask but don't score.

question_type

string | null

Question format.

min_follow_ups

integer | null

Min follow-ups.

Required range: x >= 0

max_follow_ups

integer | null

Max follow-ups.

Required range: x >= 0

additional_instructions

string | null

Per-question instructions.

post_processing_evaluation_criteria

string | null

Post-interview evaluation criteria.

expected_answer

string | null

Expected answer (SMS).

expected_value

integer | null

Expected numeric value (SMS).

is_dealbreaker

boolean | null

Dealbreaker flag (SMS).

answer

any | null

Expected answer (form).

is_knockout

boolean | null

Knockout flag (form).

Dropdown options.

Show child attributes

is_answer_mandated

boolean | null

Require answer (form).

mcq_type

string | null

MCQ type (form).

operator

string | null

Validation operator (form).

file_types

string[] | null

Allowed file types (form).

allow_multiple_files

boolean | null

Multiple files (form).

slider_min

number | null

Slider min (form).

slider_max

number | null

Slider max (form).

slider_step

number | null

Slider step (form).

response_format

enum<string> | null

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

Available options:

text,

freeform,

date,

number

instructions

string | null

Instructions (voice_tags).

options

string[] | null

Options (voice_tags).

structured_config

Structured Config · object | null

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

Response

Successful Response

data

QuestionResponse · object

required

A question or criterion belonging to a posting.

The modality field indicates the question type (voice, sms, form, resume_eligibility, resume_scoring, voice_tags). Fields that are not applicable to a given modality will be null.

Show child attributes

Public API

MCP Server

API Reference

Webhooks

Authorizations

Headers

Path Parameters

Body

Response