v1.0.0-rc.4 – API Refinements and SDK Improvements

Date: 2025-10-03 Status: Release Candidate 4

This release includes improvements identified during the Integration of Pixop and Mimir using their respective REST APIs. As part of the integration effort, we refined the Pixop REST API and SDK to support better interoperability, robustness, and extensibility.

Added

Support for embedding Basic authentication credentials in webhook URLs
Ability to set or update the description of a video
mimeType, fileExtension, and suggestedFileName fields added to VideoDownloadUrl
errorCodeEnum added to the Error schema
isProcessing and isIngesting flags added to VideoFlags
TransactionType and WebhookEventDataType are now defined as enums
Endpoint to fetch details of the default project

Fixed

Replaced *.cancelled webhook event types with a unified video.deleted webhook event type
Some endpoints were missing X-RateLimit-* headers in responses. These are now consistently included
Fixed WebhookPatch schema to allow explicitly sending a null eventTypes array to signal no changes
Required fields across multiple schemas have been updated to more accurately reflect which values are guaranteed to be non-null
Removed restriction that only one active pre-signed download URL could exist per video

SDK (pixop-api-java-sdk)

Breaking: WebhookSignatureVerifier has been improved and its interface updated
Breaking: Java SDK code generation changed from okhttp-gson to apache httpclient
Enums now include a default fallback: unknown_default_open_api instead of throwing IllegalArgumentException
All JSON serialization/deserialization now uses Jackson and gracefully handles unknown or additional fields

Notes

This release is part of the continued stabilization effort toward a stable v1.0.0
Please report feedback, questions, or issues to [email protected]