Skip to main content
POST
/
agents
/
{agentId}
/
share
Share Agent
curl --request POST \
  --url https://voice-livekit.studio.lyzr.ai/v1/agents/{agentId}/share \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email_ids": [
    "colleague@company.com"
  ],
  "admin_user_id": "admin_12345"
}
'
{
  "success": true,
  "message": "Agent shared successfully"
}
Grant other users access to a specific Voice Agent. This endpoint is ideal for collaborative environments where multiple team members need to view, test, or manage the same agent configuration. Instead of requiring internal user IDs, you can simply invite users using their email addresses.
Authentication Required: You must include your API key in the x-api-key header to authenticate this request. Ensure the API key belongs to a user with permission to share this agent.

​
Required Parameters & Payload

  1. agentId (Path Parameter): Provide the unique 24-character ID of the agent you are sharing directly in the URL.
  2. Request Body: You must pass a JSON payload specifying who receives access.
    • email_ids: An array of strings containing the email addresses of the users you want to invite.
    • admin_user_id: The ID of the administrator or owner who is authorizing this share action.

​
Example Usage

If you want to share an agent with two developers on your team, your request body would look like this: 
{
  "email_ids": [
    "developer1@yourcompany.com",
    "developer2@yourcompany.com"
  ],
  "admin_user_id": "admin_98765"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
agentId
string
required

The unique identifier of the agent to be shared.

Example:

"f790923795a23467555c0ad6"

Body

application/json
​
email_ids
string[]

A list of email addresses belonging to the users you want to share the agent with.

​
admin_user_id
string

The ID of the admin user authorizing the share operation.

Example:

"admin_12345"

Response

Share operation completed successfully.

The response is of type object.