Skip to content
General Augment Docs

Start Browser Auth

POST
/api/v3/auth/browser/start
curl --request POST \
  --url https://example.com/api/v3/auth/browser/start \
  --header 'Content-Type: application/json' \
  --data '{ "client_name": "genaug-cli", "code_challenge": "example", "code_challenge_method": "S256", "device_name": "example", "redirect_uri": "example", "scopes": [ "example" ] }'

Start browser auth for a local CLI using PKCE.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
InstallerBrowserStart

CLI request to start browser authentication with PKCE.

object
client_name
Client Name
string
default: genaug-cli >= 1 characters <= 80 characters
code_challenge
required
Code Challenge
string
>= 43 characters <= 128 characters
code_challenge_method
Code Challenge Method
string
default: S256
Allowed value: S256
device_name
Any of:
string
<= 80 characters
redirect_uri
required
Redirect Uri
string
>= 1 characters <= 500 characters
scopes
Scopes
Array<string>

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
InstallerBrowserStartResponse
object
authorize_url
required
Authorize Url
string
expires_at
required
Expires At
string format: date-time
request_id
required
Request Id
string
scopes
required
Scopes
Array<string>
Examplegenerated
{
  "authorize_url": "example",
  "expires_at": "2026-04-15T12:00:00Z",
  "request_id": "example",
  "scopes": [
    "example"
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}