Skip to main content
GET
Get an agent's share link

Authorizations

Authorization
string
header
required

Enter your API key (Bearer token)

Path Parameters

agent_id
string
required

The agent the link opens a call with.

Response

agent_reachable
boolean
required

Whether someone with the link can talk to the agent at all. false when the agent has versioning on and nothing published yet: publish it first. Unpublished edits do not make this false.

Example:

true

limit
enum<string> | null
required

Why people opening the link are being turned away right now, or null if they are not. daily: the agent has started all 30 of its calls in the last 24 hours. plan_minutes: the workspace has used its plan minutes and extra usage is off.

Available options:
daily,
plan_minutes
Example:

null

The agent's current link (the newest one not turned off), or null if it has none.