Agents

Create share link

Publish a mosaic behind a link anyone can open. With duplicate set to true the mosaic is copied first, including its renders and media, and the copy is published so the original stays private.

post/agent/{agent_id}/share

Request

  • Base URL
    https://api.mosaic.so
  • URL
    https://api.mosaic.so/agent/{agent_id}/share
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Path parameters

agent_idstring required

The ID of the agent to share

Request body

duplicateboolean

Share a copy of the mosaic instead of the mosaic itself, leaving the original private.

include_assetsboolean

When duplicating, copy completed renders and the media they reference.

run_idstring uuid

Finished run (completed or partial_complete) whose renders should be copied. Requires duplicate=true and include_assets=true.

namestring
descriptionstring

Response

Mosaic shared

agent_idstring

The shared mosaic. When duplicate is true this is the new copy.

namestring
visibility'public' | 'private'
share_urlstring nullable

Link anyone can open, or null when the mosaic is private.

source_agent_idstring

Mosaic the copy was made from. Only present when duplicate is true.

source_run_idstring uuid nullable

Completed run used as the render source, or null when template-node renders were copied.

duplicatedboolean

Changes

No recorded changes to this operation across all 1 revision of this API.