Share Pipeline

Instill Core offers the capability to disseminate your creations either via a share link or by setting them to public visibility. This allows other users to view your pipeline.

Share Pipeline via API

Please refer to the Pipeline Object and Update Pipeline pages. Users can utilize the sharing field to manage pipeline visibility, including publishing, unpublishing, or sharing a link. This structure also enables more fine-grained permission control in the future.

Publish

When you publish the pipeline, the pipeline becomes public.

{
  "sharing": {
    "users": {
      "*/*": {
        "enabled": true,
        "role": "ROLE_EXECUTOR"
      }
    }
  }
}

Unpublish

When you unpublish the pipeline, the pipeline becomes private.

{
  "sharing": {
    "users": {
      "*/*": {
        "enabled": false,
        "role": "ROLE_EXECUTOR"
      }
    }
  }
}

Sharing Link

When you shares the pipeline via a link, the pipeline returns a code. Others can use this code in the URL path to access the pipeline: http://localhost:3000/admin/pipelines/PIPELINE\_ID/playground?view=\{code}

{
  "sharing": {
    "shareCode": {
      "user": "*/*",
      "role": "ROLE_EXECUTOR",
      "enabled": true,
      "code": "a-share-code" // response-only
    }
  }
}

Share Pipeline via Console

Follow the steps below to share your pipeline:

Access sharing settings: Click the Share button, also positioned in the top-right corner.
Sharing link:
- To distribute via a link, press Copy Link to copy the pipeline's URL to your clipboard.
Publish the pipeline:
- To transition a private pipeline to public visibility, press the Publish tab at the top of the pop-up window, followed by the Publish button once more.
Unpublish the pipeline:
- You can also revert a public pipeline back to private status by following similar steps as for publishing but now pressing the Unpublish button. This ensures your pipeline is returned to private visibility.