Multipart Form Upload Block

Upload files to external APIs using multipart form data.

This article explains how to use the Multipart Form Upload custom block in Omniscope to send files to external systems using multipart form data. This is useful when integrating with APIs that expect uploads in the same format as Postman or similar tools.

It is ideal for workflows where an external system generates a file and Omniscope is responsible for posting it to a remote API endpoint.

When to use this block

Use the Multipart Form Upload block when:

• The target API expects a multipart form data request.

• You need to submit a file and additional fields in a multipart structure.

• Other blocks do not meet your requirements.

  • File Output block performs a PUT request and writes the file directly.

  • Batch HTTP block does not support multipart form data and cannot construct multipart bodies.

Adding the block to your workflow

1. Open your workflow.

2. Open the block palette.

3. Select Outputs > Multipart Form Upload.

4. Place the block anywhere in your workflow.

Configuring the block options

The block contains simple configuration options.

Upload URL

Enter the API endpoint where the file should be posted.

File path

Browse to the local or embedded file that you want to upload.

Form field name

Most APIs expect the file under the field name file.
If your API uses a different name, update it here.

Additional form fields (optional)

You can add extra form fields if your API requires them.

Adding authentication or custom headers

If your API requires an API key or any custom header, you can add it directly inside the script.

How to edit the script

1. Open the block options dialog.

2. Click the three dots menu in the top right.

3. Select Unlock Custom Block Design.

4. Scroll to the top of the script and modify the CUSTOM_HEADERS dictionary.

CUSTOM_HEADERS = {
    "ApiKey": "23423423"
}