API Reference

Generate Document

post
https://app.omnidocs.cloud/api/v1/units//recipes//generate

A document is generated based on the input data in the request body, unit id, recipe id, and the content type (mimeType or Accept header).

Input data needs to be wrapped in a json object as values, with pdf attachments optionally added as documentAttachments when generating a pdf.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the unit.

string
required

The id of the recipe.

Query Params
string

The requested content type of the generated file. This takes precedence over the Accept header.

string

The requested filename of the generated file. This takes precedence over a dynamic filename configuration on the recipe.

boolean
Defaults to false

If data should be cascaded into nested recipes from recipe references. If true, values are expected to be a mostly-flat structure, without nested recipe content.

string
Body Params
values
object
required

Key/value pairs used to populate the document template.

documentAttachments
array of objects

Optional attachments (e.g., PDFs) to include during generation.

documentAttachments
theme
object
Headers
string
enum

Output file type, used if compatible. */* is the original recipe format.

Allowed:
Responses

Updated 4 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 days ago