User

Sign in with email

Send a magic link to the user's email to sign in. If the specified email doesn't correspond to an user, the endpoint succeeds silently.

post/v1/{organization}/user/signin

Request

Base URL
https://api.amigo.ai
Auth
none required
TypeScript
https://skmtc.dev/amigo/apis/amigo-api/docs/v1/:organization/user/signin/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

redirect_linkstring uri required

An Amigo platform link that the user gets redirected to after clicking the login link.

emailstring email required

Email of the user. This must correspond to an existing, verified user in the Amigo platform.

Response

Succeeded.

unknown required

Changes

No operation changes recorded.