Launch Workflow

Endpoint URL	Method
`https://apps.inkit.com/api/v1/workflows-invoke`	`POST`

Request properties

Property	Type	Required	Description
`flow_id`	string	Yes	Workflow ID to invoke
`name`	string	No	Name for this invocation
`description`	string	No	Description for this invocation
`custom_data`	object	No	Custom metadata
`merge_parameters`	object	Yes	Template merge parameters (key-value pairs)
`custom_input_variables`	object	No	Custom input variables Default: `{}`.
`data_sources`	object	No	Data source configurations

Response properties

HTTP 201 — Workflow invoked successfully

Property	Type	Description
`id`	string	Public ID of the render data
`file_id`	string	Public ID of the file
`digital_signature_item_id`	string	Returned only when the corresponding destination is included.
`salesforce_piece_id`	string	Returned only when the corresponding destination is included.
`magic_link_piece_id`	string	Returned only when the corresponding destination is included.
`amazon_s3_piece_id`	string	Returned only when the corresponding destination is included.
`box_piece_id`	string	Returned only when the corresponding destination is included.
`dropbox_piece_id`	string	Returned only when the corresponding destination is included.
`google_drive_piece_id`	string	Returned only when the corresponding destination is included.
`docusign_piece_id`	string	Returned only when the corresponding destination is included.
`mail_piece_id`	string	Returned only when the corresponding destination is included.

Example request and response

Use an existing, enabled workflow configured for API/public invocation. It must include Inkit Storage. Configure templates, destinations, and destination input mappings on the workflow before invoking it.

curl --fail-with-body --request POST \
  "$INKIT_BASE_URL/api/v1/workflows-invoke" \
  --header "X-Inkit-API-Token: $INKIT_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "flow_id": "flow_REPLACEWITHYOURWORKFLOWID",
    "merge_parameters": {},
    "custom_input_variables": {}
  }'

flow_id and merge_parameters are required. Optional fields include name, description, custom_data, custom_input_variables, and data_sources. Custom input variable names must exist on the workflow. The server populates destinations from the workflow configuration; do not copy the render request's destinations object into this request.

The 201 response contains the render id and applicable destination identifiers. Poll /api/v1/renders/{id} to follow the invocation. Do not assume every invocation returns a document_id; use the identifiers actually returned and the render details.

The account needs workflow-launch permission and available automation capacity. A disabled workflow, wrong invocation method, invalid variable, or unavailable connector causes an error.

The production /api/v1/workflows-invoke/batch route uses session authentication. It is not an API-key batch endpoint. Older /v1/invoke and /v1/invoke/batch examples are not the request paths in this edition.