Exchange a magic link token for a session
Consumes the one-time portal redirect (magic link) token emailed during bot signup and returns an API session. The token is a UUIDv7 that encodes its creation time; it expires after a configurable validity window (15 minutes by default) and is cleared on first use. Although the action creates a session, the route uses the GET verb because it is opened from an email link. On first use the account is also initialized. For bot signup (freemium) accounts the response is a minimal envelope containing only the api_v2_token; accounts that are permitted to use magic links but are not freemium accounts may instead receive an extended session payload when additional steps (such as two-factor authentication or identity verification) are required. This endpoint is public; the magic link token in the query string is the credential.
Query parameters
Email address associated with the magic link token.
Single-use portal redirect (magic link) token, a UUIDv7 sent to the account owner's email.
Response
Session created. Bot signup accounts receive a minimal token envelope.
Example response
{
"data": {
"api_v2_token": "KEY0189A1B2C3D4E5F6071829AB3C4D5E_5FhZonmFvcw8Yq0dME27Bg"
}
}Changes
Changed in 1 of the 99 revisions of this API.1
- ○
endpoint added
endpoint-added
This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
Of the 99 revisions, 1 has no diff computed.