Check generation size

POST

https://app.schoolset.io/app/api/v1/document-templates/is-large-document

Determines whether document generation should be handled as a background job.

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

This endpoint expects an object.

document_idintegerRequired

Template ID.

entity_idslist of integersOptional

Entity IDs to test for workload sizing.

Successful POST response for /api/v1/document-templates/is-large-document.

statusenum

Allowed values:

messagestring

dataobject

1	curl -X POST https://app.schoolset.io/app/api/v1/document-templates/is-large-document \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"document_id": 42
6	}'

1	{
2	"status": "success",
3	"message": "Document size assessment completed successfully.",
4	"data": {
5	"is_large_document": false
6	}
7	}