API Reference

Queue multiple document generation jobs asynchronously [15MB payload limit]

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

Queues a batch of document generation jobs for asynchronous processing.

  • The request body is an array of items with the same structure as the single async endpoint.
  • Each item corresponds to one documentGenerationId in the response.
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
boolean
Defaults to false

If true, a metadata property is included in the webhook success message holding an object. This object has a data property with the raw request data, and a recipeId property with the id of the generated recipe. Note that this object may expand in the future with more metadata properties without notice.

Body Params
Headers
string
enum

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

Allowed:
Responses

Updated about 1 month 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 about 1 month ago