API
Authentication

User

7min

To create a digital human you will need a user and organisation (Organisation and User Create). Depending on your organization's type and privileges, you will have access to various head visuals.

Prior to utilizing the digital human API, you must request access. UNITH will create and assign an organization to your account and provide you with an authentication token. Your account will be exclusively assigned to your organization.

API Users will be of role type ADMIN

Please contact us if you need access.

Authenticate

To authenticate, use the following API endpoint, providing the registration email and token obtained from the UNITH interface.

POST https://platform-api.unith.ai/auth/enter

JSON


Authentication request example

Curl


Authentication Response

JSON


Copy the JWT Bearer authToken from the response and use for authentication purposes of all subsequent queries.

Retrieve User Information

For additional details regarding your assigned organizations, use GET /user/me

Curl


Non expiring token (secret key)

Use the following endpoint /user/generate-secret-key to generate a permanent token.

Your secret key is displayed only once for security reasons. If you do not save it, you will have to delete it and generate a new one, potentially disrupting your access.

Save your secret key and use it for integrations as needed. If you forgot your secret key, you need to follow these steps:

  1. delete your existing secret key using /user/delete-secret-key
  2. generate a new secret key using /user/generate-secret-key

In order to get a bearer token assigned to your secret key, please use the /user/auth/token endpoint with your secret key and email address.

Use the /USER/POST/AUTH/TOKEN endpoint with your secret key to generate a bearer token. Bearer tokens expire after 7 days. If your application requires a bearer token, regenerate one using this endpoint and your secret key every 7 days.