Skip to main content
POST
Start a browser sign-in for an agent

Body

application/json
clientName
string
required

What is asking for access, shown to the user on the approval page and used as the API key name, such as "Claude Code".

Required string length: 1 - 80
Pattern: ^[^\p{Cc}"\\]+$/u
Example:

"Claude Code"

workspace
string
required

The workspace to sign in to: the first part of the address the user opens Effective at, such as acme for acme.effectiveai.app. Only a user of this workspace can approve the request.

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
Example:

"acme"

Response

Sign-in started. Show the link and code to the user.

deviceCode
string
required

Secret for exchangeDeviceAuthorization. Keep it private and never show it to the user.

userCode
string
required

Short code the user confirms on the approval page.

Example:

"BCDF-GHJK"

verificationUri
string<uri>
required

Approval page, where the user can type the code.

Example:

"https://acme.effectiveai.app/device"

verificationUriComplete
string<uri>
required

Approval page with the code filled in. Show this link to the user.

Example:

"https://acme.effectiveai.app/device?code=BCDF-GHJK"

expiresAt
string<date-time>
required

When the request expires if nobody approves it.

expiresIn
integer
required

Seconds until expiresAt.

Required range: x > 0
Example:

600

interval
integer
required

Minimum seconds between exchangeDeviceAuthorization calls.

Required range: x > 0
Example:

5