API Reference

Prepare Recipe Generation

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

Stores an initial preparation context for a recipe and returns a finalize URL that can be opened in the browser to complete the document generation flow.

Preparation data is deleted upon generation or after 7 days at the latest.

Path Params
string
required

The id of the unit.

string
required

The id of the recipe.

Body Params

Partial data used to pre-fill the document generation form in the Create UI.

data
object
required

Key/value pairs used to populate the document template.

webhooks
object | null

Optional webhook definitions for success/error outcomes.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
Credentials
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