Submit file for the current step of a flow

This endpoint uploads a file for the active step in a flow to confirm the file is correctly uploaded for the current step. Submit the file in the request body using multipart/form-data.

Path parameters in the header must include both the flowId which identifies the workflow, and the x-hf-session which is the UUID for the user state within that workflow.

Optional parameters can also include x-hf-language which is the language for execution of the workflow.

Document Types

The list of allowed documents can be set when adding the File Field to a form in a workflow. When accessing the workflow via API, the Get current step response will contain the list of document types allowed for upload.

pdfword doc
pngxml
jpg/jpegexcel
bmpcsv
heictxt
webp

Path Params
string
required

The ID of the flow

Body Params
file
required

File to upload

string

Optional field ID for file upload

Headers
string
required

UUID for a user state in the execution flow (generated in the first interaction with a flow)

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json