atlasMasked
Submit the atlasMasked task
/api/v2/tasks:atlasMaskedAuthentication WLT-Api-Key
Complete masked regions across posed context views, keeping image, mask, depth, and camera arrays aligned. Read the guide.
Query parameters
waitbooleanBlock for the operation to finish before returning, up to the server wait cap. Returns the Operation either way — done with a response if it finished in time, otherwise still running.
falseHeaders
Idempotency-Keystring | nullOptional idempotency key.
length <= 128Request body
application/jsonRequired
Body of POST /api/v2/tasks:atlasMasked.
webhookUrlstring | nullWhere Marble POSTs one signed task.succeeded or task.failed event when this operation finishes; retried for 24 hours. Verify the signature with the public keys at /.well-known/webhooks/jwks.json. Cannot be combined with ?wait=true. https on port 443 only, no IP literals. Developer API only.
length <= 2048purgeContentOnOperationCompletionboolean | nullPurge this operation's outputs and the transient uploads it consumed one hour after it finishes. Omitted, the account's setting applies; true raises it for this operation; false is refused when the account already purges. Uploads in the library are never purged by an operation.
contextFramesarray<PosedRGBAAsset>requiredThe views to complete, in output order: each an image, its alpha mask, and its camera. The mask is an 8-bit grayscale PNG on the image grid where 1 is kept -- those pixels are the observed image -- and 0 is what the model fills in. Each view is completed at its targetCameras entry of the same index.
targetCamerasarray<PinholeCamera>requiredPinhole cameras for the views to generate, one per context frame in the same order. For best results, targetCameras[i] should match the camera in contextFrames[i]. Different counts or cameras that do not match their context views are accepted, but may produce lower-quality results.
promptstring | nullThe edit to make. With enhancePrompt on (the default), write an instruction that names what to add, remove, replace, or restyle and where, such as 'replace the yellow car with a stone fountain in the middle of the courtyard'. The enhancer reads it with the original context images but not the masks. Without a prompt it describes the images as they are, which tends to restore masked objects, so state removals explicitly. With enhancePrompt false the model receives the text unchanged as a caption of the finished image, so describe the whole finished scene instead.
enhancePromptbooleanRewrite the prompt before inference: the edit instruction and the context images become a detailed description of the finished scene, returned as promptUsed. Set false to send the prompt exactly as given.
truereturnDepthbooleanReturn the completed frames as posed RGBD: they are reconstructed together so the depth lands in the request's own camera frame and scale, and every entry in frames then carries a depth buffer. Needs at least two targetCameras. Limitation: the depth scale is recovered from the frames' camera centres, so views that share one centre (a pure-rotation rig) come back with a 0.0 or NaN scale and a success status.
falsemodelParametersobjectModel-specific parameters for atlasMasked.
Responses
201
Successful Response
application/json
Long-running operation whose successful terminal response has type AtlasMaskedResponse. This is the common Operation envelope with a task-specific response type, not a separate operation resource.
idstringrequiredShort operation id used in /operations/{operation} paths.
ownerIdstringrequiredAccount that owns the operation.
metadataobject | nullTask information and optional progress details. Use metadata.task to interpret a generic operation response, and use done to determine completion.
donebooleanrequiredWhether the operation is terminal. When true, a non-null error indicates failure; otherwise the operation succeeded.
errorOperationError | nullFailure details when done is true and the task failed; null while running and after success.
expiresAtSecsinteger | nullTask execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
createdAtSecsinteger | nullUnix seconds when the operation was accepted.
responseAtlasMaskedResponse | nullAtlasMaskedResponse result when done is true and the task succeeded; null while running and after failure.
namestringrequiredFull resource name for the operation.
For project operations:
accounts/{account}/projects/{project}/operations/{operation}.
Operation paths accept the short id.
422
Validation Error
application/json
detailarray<ValidationError>Request example
Completed operation