Create agent API connection
Agent connections cannot attach devices. Access read/act is a ceiling; action calls also require a live per-device function grant.
POST
/v1/agent-connectionsAuthorization
AuthorizationBearer token (Clerk owner session) · headerrequiredOwner identity required.
Request body
requiredapplication/jsonnamestringrequiredmin length 1 · max length 64
ttlSecondsinteger | nulldefault: 86400
Show propertiesHide properties
Any of:
integer
integernull
nullaccessstringdefault: "act"
Allowed:
readactResponses
201
Created; bearer token is returned once
dataNewConnectionrequiredShow propertiesHide properties
idstring<uuid>requiredprincipalstringrequirednamestringrequiredexpiresAtinteger | nullrequiredrevokedbooleanrequiredaccessstringrequiredAllowed:
readactoauthobjectShow propertiesHide properties
applicationIdstringrequiredclientIdstringrequiredredirectUrisstring<uri>[]requiredpublicbooleanrequiredpurposestringrequiredAllowed:
agentdevice-setupcanAttachbooleanrequireddeviceLimitintegerrequiredattachedDeviceCountintegertokenstringrequiredReturned once. Store securely; never log or commit.
400
Invalid request or validation failure
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring401
Missing or invalid credential
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring403
Insufficient access or grant
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring404
Resource not found
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring413
Request body exceeds the 16 KiB limit
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring429
Rate limit or workspace capacity limit
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring500
Internal error
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring503
Service or required integration is not configured
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring