Skip to content

Exchange email/password for a session token

POST
/v1/auth/login
curl --request POST \
--url https://example.com/v1/auth/login \
--header 'Content-Type: application/json' \
--data '{ "email": "hello@example.com", "password": "example" }'

Exchanges an email and password for a session token.

  • None
Media type application/json
object
email
required
string format: email
password
required
string format: password
Example generated
{
"email": "hello@example.com",
"password": "example"
}

OK

Media type application/json
object
expires_at
required
string format: date-time
session_id
required
string format: uuid
token
required

Opaque session token (olvs_…)

string
Example generated
{
"expires_at": "2026-04-15T12:00:00Z",
"session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"token": "example"
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}