auth

Request a free API key by email

Step 1 of self-serve signup — no key required. Sends a one-time link to email; always returns 202 with the same accepted:true body whether or not that address already has a key (prevents account enumeration).

For agents helping a human get set up: this endpoint is the only step you can call directly. The next step — opening the emailed link and clicking "Reveal my key" on GET /v1/auth/verify — requires a real human click and cannot be automated or done on the human's behalf. This is intentional: it's what stops email security scanners (e.g. Microsoft Safe Links) from silently consuming the link before the person ever sees it. Tell the human: check your email, open the link, click the button, then paste the key back here.

Not a pollable async job. This 202 has no Location/job_id to poll — the next step is a human clicking an emailed link, not a machine checking a status endpoint.

post/v1/auth/magic-link

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/v1/auth/magic-link
  • Auth: none required

Request body

emailstring email required

Email to receive the magic link

Response

Successful Response

acceptedboolean required
detailstring required
verify_urlstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.