DocsAPI reference

Start Google sign-in

Everything the browser needs to begin a Google sign-in.

get/api/auth/google/start
Authentication
None
Retries
Safe to repeat
Body
None
Version
2026-09-03

Unauthenticated by definition. Rate-limited per IP anyway: the endpoint is cheap, but an open generator of authorize URLs carrying our client id is a small gift to somebody building a phishing page.

Responses#

  • 200OKapplication/json

    GoogleStartResponse

    • authorization_urlstringrequired
    • code_verifierstringrequired
    • noncestringrequired
    • redirect_uristringrequired
    • statestringrequired
    5 response headers
    RateLimit-Limit

    Requests permitted in the current window.

    RateLimit-Remaining

    Requests left in the current window. Back off before it reaches 0.

    RateLimit-Reset

    Seconds until the current window resets.

    X-API-Version

    The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.

    X-Request-ID

    Quote this in a support request to identify the call.

Errors#

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

  • rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.

More Auth endpoints#

Something unclear or missing? Tell us and we’ll fix it.