DocMiral icon

DocMiral

Interact with the DocMiral document generation platform

Template → Get Schema

AI-generated

Summary

Retrieve the schema or sample data for a specified template in a chosen format.

Inputs

  • Template ID (required) — The unique identifier of the template to retrieve schema information for.
  • Schema Format — Specifies the format of the schema output. Options are 'Standard', 'JSON Schema', or 'OpenAI (AI Model)'.
  • Output — Choose whether to return the schema definition structure or sample data from the template. Options are 'Schema Definition' or 'Sample Data'.
  • Include Default Values — When 'Sample Data' is selected for output, determines whether default/sample values should be included in the returned data.

Output shape

a single JSON object

Returns an object containing the template schema or sample data depending on the chosen output. The output format corresponds to the selected schema format. Errors are returned in the JSON error field when applicable.

Links

Discussion