Workflow (Legacy)

Create Workflow

SecurityAPIKeyHeader

Request

Request Body schema: multipart/form-data

title

string (Title)

Default: ""

description

string (Description)

Default: ""

visibility_status

string (Visibility Status)

Default: "1"

Visibility Status:

Value	Status
"0"	Private
"1"	Unlisted
"2"	Public

image_files

Array of strings <binary> (Image Files)

Default: []

Images to upload. ...

image_urls

Array of strings (Image URLs)

Default: []

If you upload image files, this field will be ignored.

template_id

string (Template ID)

Default: "vim_new_year_2026"

Template ID of the workflow. ...

options

string (Options)

Default: "{}"

Json string of options

event_id

string (Event ID)

Default: "no_event"

Event ID of the workflow. ..

Responses

200

New Media

402

Insufficient Credit

404

Not Found

422

Validation Error

post/workflow

Request samples

curl
JavaScript
Python
Go
Node.js

Response samples

application/json

{"data": {"id": "workflow-id-12345",
"title": "My Animated Video",
"description": "Animated overlay video with background",
"visibility_status": "1",
"model": "vim_new_year_2026",
"options": {"aspect_ratio": "16:9",
"pipeline_mode": "video"
},
"images": ["https://media.vimmerse.net/user/image1.png"
],
"primary_user_id": "user@example.com",
"customer_id": "customer-id",
"processing_status": "success",
"progress_percentage": 100,
"completions": [{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step1_cropped.png"
}
],
"flow": "crop_to_content"
},
{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step2_processed.png"
}
],
"flow": "replace_alpha_with_gray"
},
{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step3_upscaled.png"
}
],
"flow": "upscale"
},
{"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/step4_animated.mp4"
}
],
"flow": "create_media"
},
{"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"flow": "video_overlay"
}
],
"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"media_result": [{"updated_at": "2025-04-11 18:42:51+00:00",
"size": 411634,
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"created_at": "2025-04-11 18:33:59.780864+00:00",
"updated_at": "2025-04-11 18:43:47.510893+00:00"
}
}

Get Workflow Status

SecurityAPIKeyHeader

Responses

200

Workflow Object

404

Not Found

422

Validation Error

get/workflow/{workflow_id}

Request samples

curl
JavaScript
Python
Go
Node.js

Response samples

application/json

{"data": {"id": "workflow-id-12345",
"title": "My Animated Video",
"description": "Animated overlay video with background",
"visibility_status": "1",
"model": "vim_new_year_2026",
"options": {"aspect_ratio": "16:9",
"pipeline_mode": "video"
},
"images": ["https://media.vimmerse.net/user/image1.png"
],
"primary_user_id": "user@example.com",
"customer_id": "customer-id",
"processing_status": "success",
"progress_percentage": 100,
"completions": [{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step1_cropped.png"
}
],
"flow": "crop_to_content"
},
{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step2_processed.png"
}
],
"flow": "replace_alpha_with_gray"
},
{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step3_upscaled.png"
}
],
"flow": "upscale"
},
{"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/step4_animated.mp4"
}
],
"flow": "create_media"
},
{"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"flow": "video_overlay"
}
],
"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"media_result": [{"updated_at": "2025-04-11 18:42:51+00:00",
"size": 411634,
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"created_at": "2025-04-11 18:33:59.780864+00:00",
"updated_at": "2025-04-11 18:43:47.510893+00:00"
}
}

Update Workflow

Update a workflow. You can update one or more of the following fields:

title: Workflow title
description: Workflow description
visibility_status: Visibility status ("0" for private, "1" for unlisted, "2" for public)
rating: Rating value (string)
delivered_at: Timestamp for when workflow was delivered (if None or not provided, current timestamp will be used when setting delivered_at)

SecurityAPIKeyHeader

Request

Request Body schema: application/json
required

property name*

additional property

any

Responses

200

Updated Workflow Object

400

Bad Request

404

Not Found

422

Validation Error

put/workflow/{workflow_id}

Request samples

curl
JavaScript
Python
Go
Node.js

Response samples

application/json

{"data": {"id": "workflow-id-12345",
"title": "My Animated Video",
"description": "Animated overlay video with background",
"visibility_status": "1",
"model": "vim_new_year_2026",
"options": {"aspect_ratio": "16:9",
"pipeline_mode": "video"
},
"images": ["https://media.vimmerse.net/user/image1.png"
],
"primary_user_id": "user@example.com",
"customer_id": "customer-id",
"processing_status": "success",
"progress_percentage": 100,
"completions": [{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step1_cropped.png"
}
],
"flow": "crop_to_content"
},
{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step2_processed.png"
}
],
"flow": "replace_alpha_with_gray"
},
{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step3_upscaled.png"
}
],
"flow": "upscale"
},
{"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/step4_animated.mp4"
}
],
"flow": "create_media"
},
{"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"flow": "video_overlay"
}
],
"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"media_result": [{"updated_at": "2025-04-11 18:42:51+00:00",
"size": 411634,
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"created_at": "2025-04-11 18:33:59.780864+00:00",
"updated_at": "2025-04-11 18:43:47.510893+00:00"
}
}

Delete Workflow

Delete a workflow and its associated S3 files.

SecurityAPIKeyHeader

Responses

200

Deleted Workflow Object

404

Not Found

422

Validation Error

delete/workflow/{workflow_id}

Request samples

curl
JavaScript
Python
Go
Node.js

Response samples

application/json

{"data": {"id": "workflow-id-12345",
"title": "My Animated Video",
"description": "Animated overlay video with background",
"visibility_status": "1",
"model": "vim_new_year_2026",
"options": {"aspect_ratio": "16:9",
"pipeline_mode": "video"
},
"images": ["https://media.vimmerse.net/user/image1.png"
],
"primary_user_id": "user@example.com",
"customer_id": "customer-id",
"processing_status": "success",
"progress_percentage": 100,
"completions": [{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step1_cropped.png"
}
],
"flow": "crop_to_content"
},
{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step2_processed.png"
}
],
"flow": "replace_alpha_with_gray"
},
{"result": [{"content_type": "image/png",
"url": "https://media.vimmerse.net/workflow/step3_upscaled.png"
}
],
"flow": "upscale"
},
{"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/step4_animated.mp4"
}
],
"flow": "create_media"
},
{"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"flow": "video_overlay"
}
],
"result": [{"content_type": "video/mp4",
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"media_result": [{"updated_at": "2025-04-11 18:42:51+00:00",
"size": 411634,
"url": "https://media.vimmerse.net/workflow/final_output.mp4"
}
],
"created_at": "2025-04-11 18:33:59.780864+00:00",
"updated_at": "2025-04-11 18:43:47.510893+00:00"
}
}

Log Customer Script Error

Log customer script errors to S3. Errors are organized by customer_id and weekly period. Logs reset every week, with all errors for a week stored in a single file.

Request body should contain:

error_message (required): Error message from customer script
context (optional): Additional context information (e.g., workflow_id, script_name, etc.)

SecurityAPIKeyHeader

Request

Request Body schema: application/json
required

property name*

additional property

any

Responses

200

Error logged successfully

400

Bad Request

422

Validation Error

post/workflow/error-log

Request samples

curl
JavaScript
Python
Go
Node.js

Response samples

application/json

{"data": {"message": "Error logged successfully",
"log_path": "customer-error-logs/customer_id/errors-2024-W15.log",
"log_url": "https://media.vimmerse.net/customer-error-logs/customer_id/errors-2024-W15.log"
}
}

➔ Next to Event

Workflow (Legacy)

Create Workflow

Request Body schema: multipart/form-data

Get Workflow Status

Update Workflow

Request Body schema: application/jsonrequired

Delete Workflow

Log Customer Script Error

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required