API ReferenceChangelog
Log In
API Reference

User workflows

Pixop–Mimir integration — User workflows

This guide describes the most common day-to-day workflows for Mimir users working with the Pixop integration.

Terminology used below refers to metadata on the Mimir item (Pixop subtype), such as pixopIngestionStatus, pixopProcessingStatus, and pixopComparisonLink.


Workflow 1 — Ingest media to Pixop (prepare for processing)

Use this workflow to upload/ingest media into Pixop so it can be enhanced later.

  1. In Mimir, select one or more items that do not have pixopIngestionStatus set.
  2. Right-click the selection and choose the custom action Ingest in Pixop.
  3. Wait for ingestion to complete.
  4. Verify the result:
    • A comment is added to the item describing the outcome (unless ingestion comments are disabled).
    • If ingestion is successful, the item is ready for Workflow 2.

Workflow 2 — Enhance media in Pixop

Use this workflow to create a new version of your media in Mimir by running a Pixop enhancement configuration.

2.1 Start enhancement

  1. Select one or more items where pixopIngestionStatus is COMPLETED.
  2. Run the custom action Enhance in Pixop....
  3. In the confirmation step, select the desired Pixop processing configuration and submit.
  4. The integration creates a new version of each selected item in the background and runs a processing appraisal to calculate the cost.

2.2 Approve or reject the price (if required by the integration configuration)

  1. Items that require approval will move to pixopProcessingStatus = AWAITING_APPROVAL.

  2. To reject a price:

    1. Select the items you do not want to process.

    2. Run the custom action Accept or reject the Pixop video enhancement price....

    3. Choose Reject and delete version and submit.

    4. The created versions are moved to the recycle bin.

  3. To accept a price:

    1. Select the items you want to process.

    2. Run the custom action Accept or reject the Pixop video enhancement price....

    3. Choose Accept and start processing and submit.

Note: Items that remain in AWAITING_APPROVAL for more than 24 hours may be cleaned up in Pixop. In that case, the custom action will fail and the new version must be deleted manually in Mimir.

2.3 Wait for completion and review

  1. Wait for processing to complete.
  2. Verify the result:
    • A comment is added to the item describing the outcome (unless processing comments are disabled).
    • pixopComparisonLink is populated when available, allowing you to compare the old and new version of the item.

Tip (cost control): Experiment with processing configurations on short test subclips first.
Known limitation: Virtual clips do not currently work correctly.


Workflow 3 — Clean up data in Pixop

Use this workflow to cancel jobs or remove data in Pixop when you no longer need it.

  1. Select one or more items and run the custom action Delete the video in Pixop....
  2. Choose one of the options:
    • Also delete derived videos
      Use this to delete the master video record and all derived videos in Pixop.
    • Fail the request if derived videos exist
      Use this when you only want to cancel a job or delete Pixop data for the selected items, and you want to avoid deleting derived videos.
  3. After cleanup completes, Mimir is updated to reflect the deletion:
    • Status fields and comparison links are cleared.
    • To process the item again later, you must run Workflow 1 (Ingest media to Pixop) again.