Skip to navigation

Read hosted test-call link metadata

Returns metadata only. The bearer token is null because it is revealed only by the first successful issue or rotation. The ETag covers agent lifecycle, live publication, and the latest link capability identity and state.

Authentication

AuthorizationBearer

Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header.

Path parameters

agent_idstringRequired1-128 characters
Resource identity within the authenticated workspace.

Response headers

X-Request-IdstringOptional
Safe server request correlation ID.
ETagstringOptional

Strong hosted share-link revision. Use it as If-Match for enable, disable or rotate.

RateLimit-LimitintegerOptional
Requests allowed in the current window for the tightest applicable limit.
RateLimit-RemainingintegerOptional
Requests left in the current window.
RateLimit-ResetintegerOptional
Seconds until the current window resets.

Response

Read hosted test-call link metadata.

enabledboolean
can_shareboolean
tokenstring or null=52 characters

One-time bearer value. Null on reads and idempotent replays.

token_prefixstring or null<=12 characters
expires_atdatetime or null
max_usesinteger or null>=1
use_countinteger>=0
rate_limit_per_hourinteger or null>=1

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error