API Reference

Generate Document from Transformed Metadata

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

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

This transformed metadata has been generated by the Generate Document endpoint, using application/vnd.omnidocs.transformed-data+json as the content type.

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

The id of the unit.

Query Params
string

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

string

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

Body Params

The transformed metadata returned from the Generate Document endpoint.

Headers
string
enum

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

Allowed:
Responses

Updated 3 days ago

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

Updated 3 days ago