Share a Dataset with Another User

Grant another registered user access to your dataset using the Visual Layer sharing API.

How This Helps

Dataset sharing lets you collaborate with teammates without duplicating data. You can grant access to reviewers, annotators, or developers using a single API call.

Prerequisites

• A dataset ID (visible in the browser URL when viewing a dataset: https://app.visual-layer.com/dataset/<dataset_id>/data).
• A valid JWT token. See Authentication.
• The recipient must be a registered Visual Layer user.

---

Share a Dataset

Grant another user access to your dataset by sending their email address in a PUT request.

PUT /api/v1/manage/{dataset_id}/invite
Authorization: Bearer <jwt>
Content-Type: application/json

Parameters

Parameter	Type	Required	Description
grant_to_user_email	string	Yes	Email address of the user to grant access. Must be a registered Visual Layer account.

Example

curl -X PUT \
  -H "Authorization: Bearer <jwt>" \
  -H "Content-Type: application/json" \
  -d '{"grant_to_user_email": "[e-mail]"}' \
  "https://app.visual-layer.com/api/v1/manage/<dataset_id>/invite"

A successful request returns HTTP 200 with a null body.

---

List Dataset Members

Retrieve the list of users who currently have access to a dataset.

GET /api/v1/manage/{dataset_id}/share
Authorization: Bearer <jwt>

Example

curl -H "Authorization: Bearer <jwt>" \
  "https://app.visual-layer.com/api/v1/manage/<dataset_id>/share"

Response

[
  {
    "email": "[e-mail]",
    "role": "owner"
  },
  {
    "email": "[e-mail]",
    "role": "viewer"
  }
]

---

Python Example

import requests

VL_BASE_URL = "https://app.visual-layer.com"
JWT_TOKEN = "<your-jwt-token>"
DATASET_ID = "<your-dataset-id>"

headers = {"Authorization": f"Bearer {JWT_TOKEN}"}

# Share dataset with a colleague
resp = requests.put(
    f"{VL_BASE_URL}/api/v1/manage/{DATASET_ID}/invite",
    headers={**headers, "Content-Type": "application/json"},
    json={"grant_to_user_email": "[e-mail]"},
)
resp.raise_for_status()
print("Dataset shared successfully.")

# List current members
resp = requests.get(
    f"{VL_BASE_URL}/api/v1/manage/{DATASET_ID}/share",
    headers=headers,
)
resp.raise_for_status()
members = resp.json()
print(f"Dataset has {len(members)} member(s):")
for member in members:
    print(f"  {member['email']} — {member['role']}")

---

Response Codes

See Error Handling for the error response format and Python handling patterns.

Invite (PUT /api/v1/manage/{dataset_id}/invite)

HTTP Code	Meaning
200	User access granted successfully.
401	Unauthorized — check your JWT token.
404	Dataset not found, or the specified email does not match a registered Visual Layer account.

List Members (GET /api/v1/manage/{dataset_id}/share)

HTTP Code	Meaning
200	Members list returned successfully.
401	Unauthorized — check your JWT token.
404	Dataset not found.

---

Related Resources

Add Media to an Existing Dataset

Add new images or videos to an indexed dataset.

Export a Dataset

Export dataset media and metadata.