Skip to main content

​
Overview

A Link is a shareable public URL that connects visitors directly to a session with one of your Agents. Links can be configured with expiry dates, session limits and active/paused status to control access.

​
Fields

​
link_id
string
Unique link identifier (starts with lnk_).
​
name
string
Display name for the link (e.g. "Product Demo", "Support Bot Q1").
​
url
string
The public URL end-users visit to start a session with the agent.
​
agent
object
The full agent this link points to. See Agent.
​
status
string
Current link status:
  • active — Link is accepting new sessions
  • paused — Link is temporarily disabled; visitors cannot start sessions
  • expired — Link has passed its expiry date or reached its session limit
​
uses
number
Number of sessions that have been started via this link.
​
use_limit
number | null
Maximum number of sessions allowed. null means unlimited.
​
created_at
string
ISO 8601 timestamp of when the link was created.
​
expires_at
string | null
ISO 8601 timestamp after which the link will no longer accept sessions. null means the link never expires.

​
Status Values

ValueDescription
activeLink is live and accepting sessions
pausedLink is temporarily disabled
expiredLink has expired (time or session limit reached)

​
Example

{
  "link_id": "lnk_01J8ZK4R2N5M6P7Q8W4T",
  "name": "Product Demo",
  "url": "https://app.agenthuman.com/s/lnk_01J8ZK4R2N5M6P7Q8W4T",
  "agent": {
    "agent_id": "agnt_01J8ZK4R2N5M6P7Q8W4T",
    "name": "Support Agent",
    "avatar_image_url": "https://cdn.example.com/avatars/support.jpg",
    "created_at": "2024-01-15T10:00:00Z",
    "voice_agent": {
      "provider": "ElevenLabs",
      "agent_id": "el_agent_xxxxxxxxxxxxxxxx",
      "auth_method": "public"
    }
  },
  "status": "active",
  "uses": 12,
  "use_limit": 100,
  "created_at": "2024-01-15T10:30:00Z",
  "expires_at": "2024-02-15T10:30:00Z"
}