Apply watermark
Submit a media asset to have one or more watermarking policies applied to it. The request is processed asynchronously: the endpoint returns a submission identifier and its current status, and the watermarked asset becomes available once processing is complete.
The file to watermark must be uploaded in the file field of a multipart/form-data request.
multipart/form-data, with the asset to watermark
uploaded in the file field. Processing is asynchronous: the endpoint
returns a submission id and its status, and the watermarked asset becomes
available once the status is done.
Policies
Pass one or more values in thepolicies field. At least one is required.
Example request
Authorizations
Body
The media asset to watermark. Upload it in this field.
One or more watermarking policies to apply to the asset. At least one policy is required.
european-watermarks: apply an invisible watermark following the European (EU AI Act) transparency approach.chinese-watermarks: apply visible/invisible labels following the Chinese AIGC labelling regulation.aigc-metadata: embed AIGC / provenance metadata (seeAIGCMetadataType) without altering the pixels.custom: overlay a custom visible logo, configured through thelogo*parameters.
european-watermarks, chinese-watermarks, aigc-metadata, custom Declared nature of the content, embedded in the provenance metadata.
human, artificial, partially-ai-gen, fully-ai-gen custom policy: storage URL of the logo image to overlay on the asset.
custom policy: identifier of the storage provider that hosts logoStorageUrl.
custom policy: margin, in pixels, between the logo and the edges of the asset.
custom policy: minimum size of the logo relative to the asset (0-1).
custom policy: maximum size of the logo relative to the asset (0-1).
aigc-metadata policy: AIGC labelling level. 1 = confirmed AI-generated, 2 = probably AI-generated, 3 = suspicious / possibly AI-generated.
1, 2, 3 aigc-metadata policy: identifier of the content producer.
aigc-metadata policy: name of the content producer (the entity that generated the content).
aigc-metadata policy: name of the content propagator (the entity that distributes the content).
aigc-metadata policy: identifier of the content propagator.
Optional list of watermarking model names to use. If omitted, the default models available for your tier are used.
Author name to embed in the provenance metadata.
Response
Submission accepted. Returns the submission identifier and its current status.
Identifier of the watermarking submission. Use it to poll GET /api/v2/watermark/{id}.
Current status of the submission. result is populated only once the status is done.
new, inprogress, done, errored Watermarking result. null while the submission is still being processed; populated once status is done.
Submission-level errors raised while preparing the watermarking job. Absent when there are none.