GuidesAPIChangelogStatus
API
Sign InSign Up

Invoke a workflow

post
https://apps.inkit.com/api/v1/workflows-invoke

Invoke a workflow to generate a document. The workflow must be configured with the 'inkit_storage' destination and must be enabled.

This endpoint will initiate document generation based on the workflow configuration and provided merge parameters.

Body Params
string
required
length ≤ 32

Workflow ID to invoke

string
length between 1 and 255

Name for this invocation

string
length between 1 and 65535

Description for this invocation

custom_data
object

Custom metadata

merge_parameters
object
required

Template merge parameters (key-value pairs)

custom_input_variables
object

Custom input variables

data_sources
object

Data source configurations

Headers
string
required

API Key for authentication

Responses

Updated 3 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago