Learn how to authenticate to the Corti API and make your first request
Follow these steps to get access and start building:
Get access
The Corti API Console is where you can create an account to access Corti AI
Create an account
Create a project
Create API clients
Use the client ID and client secret in your app
Develop against the API and collaborate with your project team
Monitor usage, manage billing and more
Walkthrough video
Authenticate
Authentication to the API on all environments is governed by OAuth 2.0. This authentication protocol offers enhanced security measures, ensuring that access to patient data and medical documentation is securely managed and compliant with healthcare regulations.
To acquire an access token, make a request to the authURL provided to you:
The full request body that needs to be of Content-Type: "application/x-www-form-urlencoded"
looks like this:
It will return you an access_token
:
As you can see, the access token expires after 300 seconds (5 minutes). By default as per oAuth standards, no refresh token is used in this flow. There are many available modules to manage monitoring expiry and acquiring a new access token. However, a refresh token can be enabled if needed.
Code examples
Example authentication code snippets for the Corti API in Python, JavaScript, and .NET:
Make an API request
Once you’re authenticated, make requests against the API. Below is a basic example for creating an Interaction. See all API requests and specifications here.
Subsequently you use the access_token
to authenticate any API request. The baseURL is dependent on the environment:
If, for example, you are on the eu environment and want to create an interaction as the starting point for any other workflow operations your URL will look like this:
For REST API requests, your access_token
should be passed as part of the Request Header
. Additionally you need to include the Tenant-Name
parameter:
For WebSocket connections, the access_token
should be passed in as URL parameter. The Tenant-Name
is already part of the WebSocket url returned with the create interaction request:
Walkthrough video
Python app example
Walkthrough video
For support or questions, please reach out via help.corti.ai.
Learn how to authenticate to the Corti API and make your first request
Follow these steps to get access and start building:
Get access
The Corti API Console is where you can create an account to access Corti AI
Create an account
Create a project
Create API clients
Use the client ID and client secret in your app
Develop against the API and collaborate with your project team
Monitor usage, manage billing and more
Walkthrough video
Authenticate
Authentication to the API on all environments is governed by OAuth 2.0. This authentication protocol offers enhanced security measures, ensuring that access to patient data and medical documentation is securely managed and compliant with healthcare regulations.
To acquire an access token, make a request to the authURL provided to you:
The full request body that needs to be of Content-Type: "application/x-www-form-urlencoded"
looks like this:
It will return you an access_token
:
As you can see, the access token expires after 300 seconds (5 minutes). By default as per oAuth standards, no refresh token is used in this flow. There are many available modules to manage monitoring expiry and acquiring a new access token. However, a refresh token can be enabled if needed.
Code examples
Example authentication code snippets for the Corti API in Python, JavaScript, and .NET:
Make an API request
Once you’re authenticated, make requests against the API. Below is a basic example for creating an Interaction. See all API requests and specifications here.
Subsequently you use the access_token
to authenticate any API request. The baseURL is dependent on the environment:
If, for example, you are on the eu environment and want to create an interaction as the starting point for any other workflow operations your URL will look like this:
For REST API requests, your access_token
should be passed as part of the Request Header
. Additionally you need to include the Tenant-Name
parameter:
For WebSocket connections, the access_token
should be passed in as URL parameter. The Tenant-Name
is already part of the WebSocket url returned with the create interaction request:
Walkthrough video
Python app example
Walkthrough video
For support or questions, please reach out via help.corti.ai.