Path 4 — Fully inline dynamic template

Define the template and every section inline in the request body — no prior authoring required. Ideal for prototyping or one-off generations.

← Back to Guided Synthesis overview

Use this for prototyping, one-off generations, or workflows where you don’t want to maintain stored sections. Define both the template instructions and each section’s full generation block inline. Sections and the wrapping template are created as auto-generated resources and immediately published — and like all auto-generated aggregates, are retained for 30 days only (see Auto-generated template aggregates — 30-day retention).

JavaScript

// Replace these with your values
const INTERACTION_ID = "<your-interaction-id>";

const result = await client.documents.generate({
  outputLanguage: "en-US",
  interactionId: INTERACTION_ID,
  dynamicTemplate: {
    name: "Allergy follow-up note (inline prototype)",
    generation: {
      instructions: { prompt: "Produce a focused allergy follow-up note." },
      sections: [
        {
          heading: "History of present illness",
          instructions: {
            contentPrompt: "Summarise the recent course of the patient's allergy symptoms.",
            writingStylePrompt: "Concise, professional.",
          },
          outputSchema: { type: "string" },
        },
        {
          heading: "Plan",
          instructions: {
            contentPrompt: "Outline next steps including any medication changes, testing or follow-up.",
          },
          outputSchema: {
            type: "array",
            itemFormat: "* {item}\n",
            maxItems: 5,
            items: { type: "string" },
          },
        },
      ],
    },
  },
});

Each inline sections[] entry is a full SectionGeneration — same shape you’d POST /documents/sections with. Use the full outputSchema toolbox (string, number, boolean, array, object with fields) to constrain output. See Section Schemas for design patterns.

Mapping response output back to your inline sections

Your request supplies an ordered list of inline sections with no IDs of your own. The response assigns each a server-generated UUID and returns a sections array that preserves your request order. Use it to correlate rendered output back to your inline definitions.

Each sections entry carries:

• sectionId — the UUID to use as the key into stringDocument and structuredDocument.
• heading — the resolved section title (after any overrides), ready to render.

For the request in the snippet above, the response looks like this:

Response (excerpt)

{
  "document": {
    "templateId":        "<auto-generated-template-id>",
    "templateVersionId": "<auto-generated-version-id>",
    "outputLanguage":    "en-US",
    "sections": [
      { "sectionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "heading": "History of present illness" },
      { "sectionId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "heading": "Plan" }
    ],
    "stringDocument": {
      "f47ac10b-58cc-4372-a567-0e02b2c3d479": "32-year-old female with an itchy rash that began last week …",
      "6ba7b810-9dad-11d1-80b4-00c04fd430c8": "* Initiate corticosteroid cream\n* Follow up in 4 weeks"
    },
    "structuredDocument": {
      "f47ac10b-58cc-4372-a567-0e02b2c3d479": "32-year-old female with an itchy rash that began last week …",
      "6ba7b810-9dad-11d1-80b4-00c04fd430c8": ["Initiate corticosteroid cream", "Follow up in 4 weeks"]
    }
  }
}

The first sections entry corresponds to your first inline section, the second to your second, and so on. Iterate sections in order, use sectionId to look up the rendered text in stringDocument / structuredDocument, and use heading as the display title.

If you need the full section configuration (prompts, schema, formatting rules) rather than just the heading, read the auto-generated aggregate with GET /documents/templates/{templateId}/versions/{templateVersionId}. That aggregate is subject to the 30-day retention window, so read it soon after generation or persist the configuration in your service.

When to use this path

Scenario	Why Path 4
Prototyping a new section or schema before promoting into your stored library	Iterate in one request; no authoring overhead.
One-off generation that doesn’t justify creating a section	Inline what you need; the auto-generated aggregate is your receipt.
Experiments on prompt + schema combinations	Run the same call with variations; compare outputs.

Related

Guided Synthesis overview

Shared concepts: input context, response shape, errors, 30-day retention.

Section Schemas

Schema patterns for the outputSchema shapes you’ll define inline.