Login with email and password.

POST 
https://api.aleph-alpha.com/users/login

This should not be used by most API consumers, who should generate API tokens using the login page and use bearer authentication. This endpoint allows bootstrapping the API via login to generate more API tokens.

Request

application/json

Bodyrequired

emailstringrequired

the email address

passwordstringrequired

the password

Responses

200

OK

Response Headers

Set-Cookie

application/json

Schema

Schema

idnumberrequired

User ID

emailstringrequired

Email address of the user

rolestringrequired

Role of the user

credits_remainingnumberrequired

Remaining credits for this user

invoice_allowedbooleanrequired

Is this user post-paid?

out_of_credits_thresholdintegerrequired

Threshold for out-of-credits notification. If the threshold gets crossed with a task, then we trigger an email.

terms_of_service_versionstringrequired

Version string of the terms of service that the user has accepted

Example (auto)

{
  "id": 0,
  "email": "string",
  "role": "string",
  "credits_remaining": 0,
  "invoice_allowed": true,
  "out_of_credits_threshold": 0,
  "terms_of_service_version": "string"
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.aleph-alpha.com/users/login");
request.Headers.Add("Accept", "application/json");
var content = new StringContent("{\n  \"email\": \"string\",\n  \"password\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.aleph-alpha.com

Body required

{
  "email": "string",
  "password": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!