User

Login Endpoint `POST` /v1/api/user/login

Resource URL	/v1/api/user/login
Response Format	JSON
Requires Authentication	No
Rate Limited	No
HTTPS	Yes

Description

Authenticate a user and provide access credentials.

Request Body

Parameter	Description	Required	Type	Default Value
email	User's email	Yes	String	N/A
password	User's password	Yes	String	N/A

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/user/login' \
-H 'accept: application/json' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d '[email protected]&password=securepassword123'

Example Response

curl -X 'POST' \
'https://braegen.ai/v1/api/user/login' \
-H 'accept: application/json' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d '[email protected]&password=securepassword123'

HTTP Responses

HTTP Code	Message
200	Success
422	Validation Error

Refresh Token Endpoint `POST` /v1/api/user/refresh-token

Resource URL	/v1/api/user/refresh-token
Response Format	JSON
Requires Authentication	Yes
Rate Limited	No
HTTPS	Yes

Description

Refresh an existing authentication token.

Request Body

Parameter	Description	Required	Type	Default Value
token	Current refresh token	Yes	String	N/A

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/user/refresh-token' \
-H 'accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'token=refresh_token_value'

Example Response

{
    "is_error": false,
    "message": "Token refreshed successfully",
    "results": {
        "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
        "token_type": "bearer"
    }
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

Logout Endpoint `POST` /v1/api/user/logout

Resource URL	/v1/api/user/logout
Response Format	JSON
Requires Authentication	Yes
Rate Limited	No
HTTPS	Yes

Description

Log out a user and invalidate their session.

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/user/logout' \
-H 'accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

Example Response

{
    "is_error": false,
    "message": "Logout successful",
    "results": {}
}

HTTP Responses

HTTP Code	Message
200	Successful Response
422	Validation Error

User

Login Endpoint POST /v1/api/user/login

HTTP Responses

Refresh Token Endpoint POST /v1/api/user/refresh-token

HTTP Responses

Logout Endpoint POST /v1/api/user/logout

HTTP Responses

On this page

Login Endpoint `POST` /v1/api/user/login

Refresh Token Endpoint `POST` /v1/api/user/refresh-token

Logout Endpoint `POST` /v1/api/user/logout