Link to talk to an agent

POST
/v1/agents/{id}/try-link

Makes a short-lived link to the agent's talk page in the dashboard, where a signed-in member of the workspace can talk to it by voice or text (the draft or what is live). A terminal can print it for the person to open. The link stops working after expiresAt and opens only for a member of the workspace the agent is in. Talking is charged as testing, as in the Playground.

Requires an API key with the workspace:read scope.

Authorization

apiKey
headerAuthorizationBearer <token>

A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.

Path Parameters

id*string

The agent id.

Response Body

A link that opens the agent in the dashboard for a signed-in member of the workspace

application/json
  1. response
agentId*string
url*string
expiresAt*string
Example Request
curl -X POST "https://api.vlayers.ai/v1/agents/$AGENT_ID/try-link" \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "agentId": "0192f5c2-6f7a-7b9c-8d1e-2f3a4b5c6d78",  "url": "https://vlayers.ai/dashboard/playground?agent=0192f5c2-6f7a-7b9c-8d1e-2f3a4b5c6d78&try=eyJ2IjoxfQ.0f3a",  "expiresAt": "2026-10-20T15:04:05.000Z"}