Authentication

Automatically authenticate user information.

Received's APIs use a Bearer token in the Authorization header for each request. This token is obtained after a successful login or registration process and must be securely stored by the client. Ensure the header format is "Authorization: Bearer <your_token_here>", where "<your_token_here>" is replaced with your actual token.

Endpoint on this page

POST https://api.received.ai/auth/login
POST https://api.received.ai/auth/logout
POST https://api.received.ai/auth/keys/generate
GET https://api.received.ai/auth/keys/list
DELETE https://api.received.ai/auth/user/<api_key

Authenticate API user

Authenticate user and return JWT token for future requests. The JWT token is used to authenticate the user in the API Gateway.

API Login

POST https://api.received.ai/auth/login

{
  "api_key": "{{api_key}}",
  "password": "{{api_password}}"
}

Responses

JWT token for future requests.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZIjoiSm9obiBEb2UiLCJpYXQiOjE1MTYyMzkwMjJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

Schema

Term	Type	Description	Example
username*	String	API Key	46SQZ49LT100U2QWQ3SI
password*	String	API Password	************

API Key Generation

API keys serve as unique identifiers to authenticate API clients, ensuring that the client is authorized to access the requested resources. Upon successful login, the API issues a JWT (JSON Web Token) to the client, which encapsulates the user's identity and permissions in a secure format. This JWT can then be used for subsequent API calls, streamlining the authentication process and enhancing security by limiting exposure of sensitive credentials.

Admin Login

POST https://api.received.ai/auth/login

{
  "email": "{{admin_email}}",
  "password": "{{admin_password}}"
}

Response

Cookie session for further requests with Admin permissions

Generating API key

POST https://api.received.ai/auth/keys/generate

Response

API keys are critical for securing access to web services, acting as unique identifiers for each user or application. To keep them safe, it's essential to store them securely, avoid sharing them publicly, and use environment variables or encrypted secrets management services to manage them in applications.

{
  "api_key": "{{api_key}}",
  "password": "{{api_password}}"
}

Explore More APIs

Delves into additional authentication methods and initial setup instructions, broadening your integration capabilities and enhancing secure access

Admin Logout

POST https://api.received.ai/auth/logout

List API Keys

GET https://api.received.ai/auth/keys/list

Response

[
    {
        "api_key_ref": "{{api_key_ref}}",
        "api_key": "{{api_key}}"
    }
]

Delete API key

DELETE https://api.received.ai/auth/user/<api_key_ref>