API ReferenceChangelog
Log In
API Reference

Create or update the Pixop Mimir integration

put
https://integrations.pixop.com/mimir/v1/admin/pixop-mimir-integration

Creates or updates the integration between a Pixop team and a Mimir tenant.

The integration includes:

  • The mapping between the Pixop team and Mimir tenant.
  • The Pixop webhook used to receive job status changes.
  • Optionally, Mimir configuration specified by mimirSetup.

The integration remains active for the period specified by daysToLive (default: 90 days). Its TTL is reset whenever this endpoint is called or a new Pixop job is initiated. When the TTL expires, the integration is deleted with the same effect as calling DELETE /v1/admin/pixop-mimir-integration.

The x-mimir-api-key and x-pixop-api-key must remain valid while the integration is active. Calling this endpoint updates the stored API keys, so it can also be used for API key rotation. We recommend using API keys without a fixed expiry and rotating them periodically.

If mimirSetup is provided, the requested Mimir setup is applied. This includes Pixop custom actions and the associated Mimir UI configuration. Any manual steps required to complete the setup are returned in the response. If mimirSetup is omitted, the integration mapping and Pixop webhook are created or updated without changing the Mimir setup.

Notes:

  • If mimirSetup references Pixop processing configurations that do not exist, a 400 Bad Request is returned with the invalid configuration IDs.
  • If the Mimir setup fails, the request fails and no changes are made to the integration mapping or webhook.
  • If the tenant is already associated with a different Pixop team, a 409 Conflict is returned.

Please also check Mimir admin setup guide and User workflows for more information on how to set up and use the integration.

Note: The Pixop–Mimir integration uses Mimir APIs on your behalf using API keys you provide. Ensure your organization’s use complies with your agreement with Fonn/Mimir.

This integration is connected to Fonn, enabling seamless interaction between Pixop and the Fonn-powered Mimir platform.

Query Params
integer
1 to 90
Defaults to 90

Life span (in days) of the Pixop Mimir integration.

integer
1 to 168
Defaults to 48

Tenant-level idle lease window (in whole hours) for Pixop master videos under this tenant.

This setting applies to all current and future master videos for the tenant and governs when an unused master (and its derived outputs/clips) will be cleaned up in Pixop.

Reset semantics (the idle window is NOT reset on general access/download):

  • When a processing appraisal is requested for a specific master video.
  • When a lease is about to expire but Pixop processing for that master is still in progress at that moment (the lease is automatically re-added).
  • When a lease is about to expire but a derived output has not yet been fully copied to Mimir at that moment (the lease is automatically re-added).
  • When the tenant’s lease policy is updated (i.e., this field changes): all existing leases are recomputed relative to their lastUsed timestamps.

On update: remaining TTL for existing masters is recalculated as
remaining = newWindow - (now - lastUsed).
If remaining <= 0 and no jobs are in progress, the master is scheduled for deletion; otherwise the new TTL is applied from now.

string

The team ID in Pixop to be used for the integration. If not provided, the current default team ID associated with the provided x-pixop-api-key will be used.

integer
1 to 5
Defaults to 1

The maximum number of Pixop processing jobs allowed per pixopSourceVideo,
based on the total number of videos that have been successfully processed or are currently in progress in Pixop.
If videos are deleted in Pixop, they are not counted towards this limit. This helps control costs and manage resource usage.

boolean
Defaults to true

Whether to add a comment to the Mimir item when Pixop ingestion is finished and assign it to the user who initiated the ingestion.

boolean
Defaults to true

Whether to add a comment to the Mimir item when Pixop processing is finished and assign it to the user who initiated the processing.

Body Params

Request body for creating or updating the Pixop Mimir integration.

Request body for creating or updating the Pixop Mimir integration.

string
required

User ID in Mimir for notifications

mimirSetup
object

If provided Mimir will be set up according to this

Headers
string
required

The mimir tenant for which the integration applies.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?