Document Templates

Suggest field placements for a PDF template

POST/document-templates/{id}/actions/auto-place
document-templates:writeauto_place_document_template

Starts a job that suggests where a form's fields go on a PDF template. Nothing is saved, so nothing needs undoing: result has suggestions (position shape; apply via PUT /document-templates/{id}/positions) and skipped. Takes up to 6 minutes. Fails upstream_error or upstream_unavailable (also on a start timeout, not retried). 409 invalid_state for DOCX or a running job; 422 for an unknown form. Needs perm_can_manage_form_builder (403 missing_permission); a token user that can't be used is 403 forbidden. dry_run: 202, no job.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required

  • form_idstring (uuid)Required#

    The id of the form whose fields are to be placed. An unknown or deleted form returns 422.

{
  "form_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f"
}

Responses

202

The job that asks the placement service for suggestions was started. Its result carries the suggestions and the skipped fields.

Job
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "string",
    "status": "queued",
    "progress": {
      "done": 1,
      "total": 1
    },
    "result": {},
    "error": {},
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00",
    "completed_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/document-templates/{id}/actions/auto-place\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "form_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f"
}'