POST/api/v2/preflight
Headers
Authorizationstring requiredBearer pj_live_… Raw keys are shown only when created. The
x-api-keyheader is an alternative transport.
Body parameters
formatenum requiredpptxdocxxlsxpdfdocumentany requiredsourceSchemaconst "protocol_v2" optionalbrandPackIdstring (uuid) optionalpreflightPolicyobject optionalpreflightPolicy.renderIfScoreAbovenumber optional
Response
200 OK Structural result and persisted compatibility job identifier.
job_idstring (uuid) requiredquality_reportobject requiredquality_report.formatenum requiredpptxdocxxlsxpdfquality_report.deckScorenumber requiredquality_report.documentVerdictstring requiredquality_report.findingsarray of object requiredquality_report.structuralValidationobject requiredpolicyResultobject requiredvalidationSummaryobject required
Errors
| Status | When |
|---|---|
400 | Invalid request. |
401 | Missing, invalid, unentitled, or no-longer-accepted API key. |
404 | The organization/environment-scoped resource was not found. |
429 | Finite rate limit or durable hosted quota refused the request. |
500 | Compatibility service failure. |
curl -X POST \
-H "Authorization: Bearer pj_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"format":"pptx","document":{"version":"2.0","title":"Customer deliverable","slides":[]}}' \
https://runstamp.com/api/v2/preflightResponse 200 OK
{
"job_id": "8f4fa0a3-f907-41f5-babe-5762f974cb83",
"quality_report": {
"format": "pptx",
"deckScore": 1,
"documentVerdict": "DOCUMENTVERDICT",
"findings": [
{}
],
"structuralValidation": {}
},
"policyResult": {},
"validationSummary": {}
}