Assign a Quiz

curl --request POST \
  --url https://api.example.com/api/public/v1/project-todos/quizzes/manage \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "<string>",
  "jobId": "<string>",
  "formVersionId": "<string>",
  "completionPolicy": "<string>",
  "audience": "<string>",
  "title": "<string>",
  "description": "<string>",
  "required": true,
  "priority": "<string>",
  "blockingMode": "<string>",
  "dueOffsetMinutes": 123,
  "idempotencyKey": "<string>",
  "preflightReceipt": "<string>",
  "allowDuplicate": true
}
'

import requests

url = "https://api.example.com/api/public/v1/project-todos/quizzes/manage"

payload = {
    "action": "<string>",
    "jobId": "<string>",
    "formVersionId": "<string>",
    "completionPolicy": "<string>",
    "audience": "<string>",
    "title": "<string>",
    "description": "<string>",
    "required": True,
    "priority": "<string>",
    "blockingMode": "<string>",
    "dueOffsetMinutes": 123,
    "idempotencyKey": "<string>",
    "preflightReceipt": "<string>",
    "allowDuplicate": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    action: '<string>',
    jobId: '<string>',
    formVersionId: '<string>',
    completionPolicy: '<string>',
    audience: '<string>',
    title: '<string>',
    description: '<string>',
    required: true,
    priority: '<string>',
    blockingMode: '<string>',
    dueOffsetMinutes: 123,
    idempotencyKey: '<string>',
    preflightReceipt: '<string>',
    allowDuplicate: true
  })
};

fetch('https://api.example.com/api/public/v1/project-todos/quizzes/manage', 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.example.com/api/public/v1/project-todos/quizzes/manage",
  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([
    'action' => '<string>',
    'jobId' => '<string>',
    'formVersionId' => '<string>',
    'completionPolicy' => '<string>',
    'audience' => '<string>',
    'title' => '<string>',
    'description' => '<string>',
    'required' => true,
    'priority' => '<string>',
    'blockingMode' => '<string>',
    'dueOffsetMinutes' => 123,
    'idempotencyKey' => '<string>',
    'preflightReceipt' => '<string>',
    'allowDuplicate' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/public/v1/project-todos/quizzes/manage"

	payload := strings.NewReader("{\n  \"action\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"formVersionId\": \"<string>\",\n  \"completionPolicy\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"required\": true,\n  \"priority\": \"<string>\",\n  \"blockingMode\": \"<string>\",\n  \"dueOffsetMinutes\": 123,\n  \"idempotencyKey\": \"<string>\",\n  \"preflightReceipt\": \"<string>\",\n  \"allowDuplicate\": true\n}")

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

	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.example.com/api/public/v1/project-todos/quizzes/manage")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"formVersionId\": \"<string>\",\n  \"completionPolicy\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"required\": true,\n  \"priority\": \"<string>\",\n  \"blockingMode\": \"<string>\",\n  \"dueOffsetMinutes\": 123,\n  \"idempotencyKey\": \"<string>\",\n  \"preflightReceipt\": \"<string>\",\n  \"allowDuplicate\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/public/v1/project-todos/quizzes/manage")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"formVersionId\": \"<string>\",\n  \"completionPolicy\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"required\": true,\n  \"priority\": \"<string>\",\n  \"blockingMode\": \"<string>\",\n  \"dueOffsetMinutes\": 123,\n  \"idempotencyKey\": \"<string>\",\n  \"preflightReceipt\": \"<string>\",\n  \"allowDuplicate\": true\n}"

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

POST

api

public

project-todos

quizzes

manage

Assign a Quiz

curl --request POST \
  --url https://api.example.com/api/public/v1/project-todos/quizzes/manage \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "<string>",
  "jobId": "<string>",
  "formVersionId": "<string>",
  "completionPolicy": "<string>",
  "audience": "<string>",
  "title": "<string>",
  "description": "<string>",
  "required": true,
  "priority": "<string>",
  "blockingMode": "<string>",
  "dueOffsetMinutes": 123,
  "idempotencyKey": "<string>",
  "preflightReceipt": "<string>",
  "allowDuplicate": true
}
'

import requests

url = "https://api.example.com/api/public/v1/project-todos/quizzes/manage"

payload = {
    "action": "<string>",
    "jobId": "<string>",
    "formVersionId": "<string>",
    "completionPolicy": "<string>",
    "audience": "<string>",
    "title": "<string>",
    "description": "<string>",
    "required": True,
    "priority": "<string>",
    "blockingMode": "<string>",
    "dueOffsetMinutes": 123,
    "idempotencyKey": "<string>",
    "preflightReceipt": "<string>",
    "allowDuplicate": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    action: '<string>',
    jobId: '<string>',
    formVersionId: '<string>',
    completionPolicy: '<string>',
    audience: '<string>',
    title: '<string>',
    description: '<string>',
    required: true,
    priority: '<string>',
    blockingMode: '<string>',
    dueOffsetMinutes: 123,
    idempotencyKey: '<string>',
    preflightReceipt: '<string>',
    allowDuplicate: true
  })
};

fetch('https://api.example.com/api/public/v1/project-todos/quizzes/manage', 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.example.com/api/public/v1/project-todos/quizzes/manage",
  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([
    'action' => '<string>',
    'jobId' => '<string>',
    'formVersionId' => '<string>',
    'completionPolicy' => '<string>',
    'audience' => '<string>',
    'title' => '<string>',
    'description' => '<string>',
    'required' => true,
    'priority' => '<string>',
    'blockingMode' => '<string>',
    'dueOffsetMinutes' => 123,
    'idempotencyKey' => '<string>',
    'preflightReceipt' => '<string>',
    'allowDuplicate' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/public/v1/project-todos/quizzes/manage"

	payload := strings.NewReader("{\n  \"action\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"formVersionId\": \"<string>\",\n  \"completionPolicy\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"required\": true,\n  \"priority\": \"<string>\",\n  \"blockingMode\": \"<string>\",\n  \"dueOffsetMinutes\": 123,\n  \"idempotencyKey\": \"<string>\",\n  \"preflightReceipt\": \"<string>\",\n  \"allowDuplicate\": true\n}")

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

	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.example.com/api/public/v1/project-todos/quizzes/manage")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"formVersionId\": \"<string>\",\n  \"completionPolicy\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"required\": true,\n  \"priority\": \"<string>\",\n  \"blockingMode\": \"<string>\",\n  \"dueOffsetMinutes\": 123,\n  \"idempotencyKey\": \"<string>\",\n  \"preflightReceipt\": \"<string>\",\n  \"allowDuplicate\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/public/v1/project-todos/quizzes/manage")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"formVersionId\": \"<string>\",\n  \"completionPolicy\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"required\": true,\n  \"priority\": \"<string>\",\n  \"blockingMode\": \"<string>\",\n  \"dueOffsetMinutes\": 123,\n  \"idempotencyKey\": \"<string>\",\n  \"preflightReceipt\": \"<string>\",\n  \"allowDuplicate\": true\n}"

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

Assigning a quiz is a fan-out, so it carries the full audience safety contract: an explicit audience, strict SELECTED validation, and a signed preflight receipt for broad audiences. The server computes all binding hashes itself — you never hand-craft them. Requires project_todos:write and employer access to the job.

`quiz_todo_preflight`

A no-write preview of the exact assignment. It mirrors every live gate: the job must have Project To-dos enabled, the version must be published, and ON_PASS requires a pass rule and no manually graded questions — a live-invalid request fails the preflight and returns no receipt.

string

required

quiz_todo_preflight

string

required

string

required

The immutable published version to pin.

string

required

ON_SUBMIT, ON_PASS, or ON_REVIEW.

string

required

No default; SELECTED requires exact same-job active selectedContractIds.

string

Optional override; defaults to the form title.

string

boolean

string

number

The preflight response includes the exact job and form version, the live masked recipients and count, future-hire semantics, projected due and blocking behavior, duplicates.sameFormVersion (active to-dos already pinning this exact version), warnings, and — for broad audiences — the receipt to pass back.

`quiz_todo_create`

Creates the item and every initial assignment atomically. Send the identical payload plus:

string

required

A stable key; retries of the identical request converge and never widen the original fan-out.

string

Required for ACTIVE, FUTURE, and ACTIVE_AND_FUTURE.

boolean

Overrides the exact-duplicate refusal.

Normalized result

{
  "ok": true,
  "action": "quiz_todo_create",
  "itemId": "…",
  "versionId": "…",
  "audience": "ACTIVE",
  "includesFutureHires": false,
  "fanOut": {
    "matchedContracts": 2,
    "createdAssignments": 2,
    "skippedExistingAssignments": 0,
    "failedAssignments": 0,
    "assignmentIds": ["…", "…"]
  },
  "recipients": [{ "contractId": "…", "displayName": "Alex B." }],
  "replayed": false,
  "warnings": []
}

failedAssignments is always 0 on success: the transaction cannot commit a partial fan-out. skippedExistingAssignments counts recipients who already held this operation’s assignment on a convergent retry. Assigned quizzes are immediately visible to the AI trainers they target.

⌘I

Getting started

Connect your agent

Core concepts

Guides

API reference

CLI

MCP server

Annotation platforms

Assign a Quiz

`quiz_todo_preflight`

`quiz_todo_create`

Normalized result

​quiz_todo_preflight

​quiz_todo_create

​Normalized result

`quiz_todo_preflight`

`quiz_todo_create`

Normalized result