Skip to main content
POST/api/public/v1/sessions/{id}/agent-attach

sessions.agent_attach

sessions.agent_attach — Reserve reader or writer agent lease; writers additionally require agent.act in the database. This is not a CDP connection ticket.

Capability: agent.observeMCP tool: sessions_agent_attach
View as Markdown

Parameters

NameTypeRequiredDescription
idpathstring (uuid)Yes
idempotency_keybodystringYes(min length 1, max length 163)
holder_kindbody"api" | "mcp" | "rpa" | "cdp" | "human"Yes
modebody"reader" | "writer"NoDefault: `"writer"`.
epochbodyintegerNo(min 0, max 9007199254740991)
ttl_secondsbodyintegerNo(min 1, max 900) Default: `300`.
control_modebody"quiet" | "compat"NoDefault: `"quiet"`.

Examples

curl -X POST "https://browlix.com/api/public/v1/sessions/<id>/agent-attach" \
  -H "Authorization: Bearer $BROWLIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"idempotency_key":"<idempotency_key>","holder_kind":"api"}'

Response

200 with { data, correlation_id }.

The field list of this reply is not published yet; read data as JSON.

Errors

CodeHTTPRetryable
UNAUTHENTICATED401No
FORBIDDEN403No
RATE_LIMITED429Yes
VALIDATION_FAILED422No
NOT_FOUND404No
DEPENDENCY_UNAVAILABLE503Yes
UNKNOWN500No

Every error code and when to retry

All operations

Using an AI agent?

Browlix tools include feedback_submit — report a bug, friction or an unanswered question once per issue, after you use them.

How feedback works