Image

Documentation

Learn how to use our API and UI and more.

graphical divider

Managing credentials with the API

A brief guide to working with Atlas AI's Data API

Signup

New users can register directly using the register endpoint.

curl --header "Content-Type: application/x-www-form-urlencoded" \
--request POST \
--data-urlencode 'email=youremail@host.com' \
--data-urlencode 'password=yourpassword' \
--data-urlencode 'name=your name' \
https://data.atlasai.co/api/v1/register

They will recieve the JSON response below.

{
  "name":"your name",
  "email":"youremail@host.com"
  "token":"yourtoken"
}

NOTE: New users will also recieve an email with instructions on verify their account after registering. Without account verification users will not have access to the data.

When a new user is registered, an API token will be generated that is required to use many of the endpoints provided by this API. A user's email must be verified before their API token becomes valid. An email will be sent to new users providing instructions on registering their account. After validating their email, users must validate their token using the validate user endpoint.

curl --header "Content-Type: application/x-www-form-urlencoded" \
--request POST \
--data-urlencode 'email=youremail@host.com' \
--data-urlencode 'token=yourtoken' \
https://data.atlasai.co/api/v1/validate-user

A user can check that their API token is valid with the validate-api-token endpoint.

curl -G \
--data-urlencode 'email=youremail@host.com' \
--data-urlencode 'token=yourtoken' \
https://data.atlasai.co/api/v1/validate-api-key

Resetting credentials

If an API token becomes insecure, it can be reset using the reset-api-key endpoint.

curl --header "Content-Type: application/x-www-form-urlencoded" \
  --request POST \
  --data-urlencode 'email=youremail@host.com' \
  --data-urlencode 'token=yourtoken' \
  https://data.atlasai.co/api/v1/reset-api-key

The reset-api-key endpoint will generate and return an new API token while the previous token will be invalidated.

Resetting a user's password is a two step process. First request a password reset email be sent to the user using the request-password-reset endpoint.

curl --header "Content-Type: application/x-www-form-urlencoded" \
  --request POST \
  --data-urlencode 'email=youremail@host.com' \
  https://data.atlasai.co/api/v1/request-password-reset

Then, reset the password using the reset token generated in the email. This can be done with the reset-password endpoint.

curl --header "Content-Type: application/x-www-form-urlencoded" \
  --request POST \
  --data-urlencode 'password=yournewpassword' \
  --data-urlencode 'token=yourtoken' \
   https://data.atlasai.co/api/v1/reset-password
Icon For Arrow-up