Forms

Generate a document from a submission

POST/submissions/{id}/actions/generate-documents
forms:writegenerate_documents_submission

Starts a job that renders a document from the submission and one of the form's attached document templates, and answers 202 with the job. The submission need not be completed. template_id must be a template attached to the form, else 422 exists; name is optional. The job's result carries document_id, which GET /submissions/{submission_id}/documents/{id} reads. Queues a job; no webhook. DELETE on the document undoes it. dry_run: 202, no job.

Path parameters

  • idstring (uuid)Required#

    The submission's id, a uuid. An unknown id, or a submission you cannot see, returns 404.

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 · SubmissionDocumentsGenerate

  • template_idstring (uuid)Required#

    The id of a document template attached to the submission's form (the id GET /forms/{id}/templates returns).

  • namestring | null#

    A name for the generated document. The template's name is used when it is left out.

{
  "template_id": "d4e5f607-1829-4a3b-9c4d-5e6f708192a3",
  "name": "Subscription Agreement - Ada Lovelace.pdf"
}

Responses

202

The job that renders the document was started. Its result carries the generated document's id once it has succeeded.

SubmissionDocumentJobEnvelope
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "string",
    "status": "queued",
    "progress": {
      "done": 1,
      "total": 1
    },
    "result": {
      "document_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a"
    },
    "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
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/submissions/{id}/actions/generate-documents\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "template_id": "d4e5f607-1829-4a3b-9c4d-5e6f708192a3",
  "name": "Subscription Agreement - Ada Lovelace.pdf"
}'