Share Workspace Resource

POST https://api.elevenlabs.io/v1/workspace/resources//share Content-Type: application/json

Grants a role (one of 'admin', 'editor', 'commenter', or 'viewer') on a workspace resource to a user, group, or workspace (service account) API key. This overrides any existing role the target has on the resource. To target a user or service account, pass only the user email; the user must be in your workspace. To target a group, pass only the group id. To target a workspace (service account) API key, pass the api key id; the resource will be shared with the service account associated with that key. You must have admin access to the resource to share it.

Reference: https://elevenlabs.io/docs/api-reference/workspace/resources/share

Servers

https://api.elevenlabs.io (Production, default)
https://api.us.elevenlabs.io (Production US)
https://api.eu.residency.elevenlabs.io (Production EU)
https://api.in.residency.elevenlabs.io (Production India)
https://api.sg.residency.elevenlabs.io (Production Singapore)

Request

Path parameters

resource_id (string, required) — The ID of the target resource.

Body (application/json)

This endpoint expects a Body_Share_workspace_resource_v1_workspace_resources__resource_id__share_post.

role (enum, required) — Role to grant to the target: one of 'admin', 'editor', 'commenter', or 'viewer'.
- Allowed values: admin, editor, commenter, viewer
resource_type (enum, required) — Resource type of the target resource.
- Allowed values: voice, voice_collection, pronunciation_dictionary, dubbing, dubbing_project, project, convai_agents, convai_knowledge_base_documents, convai_tools, convai_settings, convai_secrets, workspace_auth_connections, convai_phone_numbers, convai_mcp_servers, convai_api_integration_connections, convai_api_integration_trigger_connections, convai_batch_calls, convai_agent_response_tests, convai_test_suite_invocations, convai_crawl_jobs, convai_crawl_tasks, convai_kb_external_sync_jobs, convai_whatsapp_accounts, convai_agent_versions, convai_agent_branches, convai_agent_versions_deployments, convai_agent_experiments, convai_memory_entries, convai_templates, dashboard, dashboard_configuration, convai_agent_drafts, resource_locators, assets, content_generations, content_templates, content_skills, songs, transcription_tasks, avatars, avatar_video_generations, resource_collection, studio_projects, convai_analysis_items
user_email (string, optional, nullable) — The email of the user or service account.
group_id (string, optional, nullable) — The ID of the target group. Use 'default' to set the resource's baseline role — every workspace member receives this role unless they hold a higher one through a direct user grant, group membership, or workspace (service account) API key.
workspace_api_key_id (string, optional, nullable) — The ID of the target workspace (service account) API key. This is not the API key string itself that you pass in the header for authentication — it is the key's ID, which workspace admins can find under Developers → Service Accounts.

Response

200

Successful Response

any

Errors

422 Unprocessable Entity Error

Validation Error

detail (list of ValidationError, optional)

Types

ValidationError

loc (list of ValidationErrorLocItems, required)
msg (string, required)
type (string, required)

ValidationErrorLocItems

Examples

Request

JSON

{
  "role": "admin",
  "resource_type": "voice"
}

SDK Code

TypeScript

import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";

async function main() {
    const client = new ElevenLabsClient();
    await client.workspace.resources.share("resource_id", {
        role: "admin",
        resourceType: "voice",
    });
}
main();

Python

from elevenlabs import ElevenLabs

client = ElevenLabs()

client.workspace.resources.share(
    resource_id="resource_id",
    role="admin",
    resource_type="voice",
)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/workspace/resources/resource_id/share"

	payload := strings.NewReader("{\n  \"role\": \"admin\",\n  \"resource_type\": \"voice\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/workspace/resources/resource_id/share")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"role\": \"admin\",\n  \"resource_type\": \"voice\"\n}"

response = http.request(request)
puts response.read_body

Java

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.elevenlabs.io/v1/workspace/resources/resource_id/share")
  .header("Content-Type", "application/json")
  .body("{\n  \"role\": \"admin\",\n  \"resource_type\": \"voice\"\n}")
  .asString();

PHP

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.elevenlabs.io/v1/workspace/resources/resource_id/share', [
  'body' => '{
  "role": "admin",
  "resource_type": "voice"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/workspace/resources/resource_id/share");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"role\": \"admin\",\n  \"resource_type\": \"voice\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Swift

import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "role": "admin",
  "resource_type": "voice"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/workspace/resources/resource_id/share")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()