Docs
API reference

Quote an interview batch

POST
/api/v1/interview-batch-quotes

Review per-item prices and fingerprints before creating an interview batch. Use this to separate items ready for submission from items that need attention.

Before you call

Send 1–20 quote inputs with unique itemKey values. Each item follows the same prerequisites as a single quote.

Required scope: interviews:write.

What happens next

Only items with a non-null quote are ready to include in a submission. total is informational; admissionGuaranteed is always false. Quoting reserves neither capacity nor allowance.

Recovery

Inspect each errorCode and correct that item before quoting again. Include the returned fingerprint in each admitted item; do not use the aggregate total as authorization for a batch.

Follow the complete workflow · Errors and retries

Authorization

ApiKey
headerAuthorizationBearer <token>

Request Body

application/json
  1. body
items*array<>

Page or batch entries. An empty list is valid; use the cursor or individual item states to decide what happens next.

Items1 <= items <= 20

Response Body

Only items with a non-null quote are ready to include in a submission. total is informational; admissionGuaranteed is always false. Quoting reserves neither capacity nor allowance.

application/json
  1. response
data*
# Set PROBB_URL and PROBB_API_KEY. Replace RESOURCE_ID if present.curl --fail-with-body -X POST "$PROBB_URL/api/v1/interview-batch-quotes" \  -H "Authorization: Bearer $PROBB_API_KEY" \  -H 'Content-Type: application/json' \  --data-binary '{  "items": [    {      "itemKey": "application-42",      "input": {        "reportId": "report_example",        "candidateEmail": "candidate@example.test",        "sendEmail": true      }    }  ]}'
{  "data": {    "total": {      "creditUnits": 100,      "creditScale": 100,      "quotedItems": 1,      "failedItems": 0,      "admissionGuaranteed": false    },    "items": [      {        "itemKey": "application-42",        "quote": {          "reportId": "report_example",          "creditUnits": 100,          "creditScale": 100,          "fingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",          "interviewSystemVersion": "assigned-interview-version"        },        "errorCode": null      }    ]  }}