List an agent's share links

GET
/v1/agents/{id}/share-links

Lists the public share links of one agent, newest first, with each one's limits, what it has used so far and when it was last used. A share link is an address anyone who has it can open to talk to the agent, by voice or by typing, without signing in; what they use is charged to the workspace's balance, up to the link's caps. The list never carries the link itself: it is shown once, when the link is made, and an admin copies it again in the dashboard.

Requires an API key with the share_links: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

The agent's links with their limits and use, never the link itself

application/json
  1. response
links*array<>

The links of the agent, newest first, with their use so far.

Example Request
curl "https://api.vlayers.ai/v1/agents/$AGENT_ID/share-links" \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "links": [    {      "id": "grt_0192f5e1a2b37c4d8e5f6a7b8c9d0e1f",      "agentId": "0192f5c2-6f7a-7b9c-8d1e-2f3a4b5c6d78",      "state": "active",      "title": "Books team test",      "displayName": "Acme Books",      "target": "live",      "sealedVersionLabel": "Published version of Nov 8",      "sealedAt": "2026-11-08T15:12:00.000Z",      "privacyUrl": "https://acmebooks.example/privacy",      "limits": {        "conversations": 20,        "voiceMinutes": 60,        "dollarsMicros": 10000000,        "atOnce": 2,        "callMinutes": 5,        "typedMessages": 40,        "typedDollarsMicros": 1000000,        "perAddressPerDay": 5,        "perAddressPerHour": 3      },      "expiresAt": "2026-11-15T15:12:00.000Z",      "tools": {        "off": [          "refund_order",          "vl_send_text"        ]      },      "usage": {        "conversations": 3,        "minutes": 12.5,        "spentMicros": 1500000      },      "lastUsedAt": "2026-11-09T09:30:00.000Z",      "revokedBy": null,      "revokedAt": null,      "createdBy": "user_2abc",      "createdAt": "2026-11-08T15:12:00.000Z",      "updatedAt": "2026-11-08T15:12:00.000Z",      "version": 3    }  ]}