Skip to main content

How to Transition Your Build to Use the Corti API Console

Updated today

We’ve made it easier and more streamlined to manage your API clients by moving to the Corti API Console. This guide walks you through the transition process, what to expect, and how to get started with your new setup.

Step 1: Accept Your Corti Console Invitation

You will receive an email from Corti notifying you that you’ve been invited to the Corti Console. The invitation is sent to the Console Owner as defined by your Corti representative (note: owners can invite other admins!).

To get started:

  1. Open the invitation email.

  2. Click the link provided to access the Corti Console.

  3. Log in with your credentials or follow the instructions to create an account if you haven’t already.

Step 2: Navigate to the API Clients Section

Once logged into the Corti Console, navigate to the API Clients section in the sidebar menu. Once created, this page will show any API clients that you have created for your project.

Step 3: Create Your New Client Through the Console

  1. Click “+ Create API Client.”

    • This will open a modal to define your new API client.

  2. Fill in the API Client details:

    1. Name: Enter a meaningful name

    2. Client ID: This is usually auto-generated based on the name, but editable. The Client ID is also prepended with the name of your Console Project.

    3. Region: Choose the deployment region where your API key will hosted (e.g., US Region or EU Region). This determines the data residency of the usage of your API Key

  3. Click “Create API Client.”

  4. Access Your API Credentials

Once you create your API client, the entry will appear on your API Clients list. To access the newly generated credentials, click the name of our client to open up the credentials.

Each client entry will display:

  • Client credentials (Client ID and Secret)

  • Environment

  • Tenant name

  • Client Secret

  • Authentication Quickstart tailored to your credentials

Step 4: Update Your Build With Your New Production Credentials

You'll note that the details of your new keys may differ from any Corti generated keys you have been provided previously. Using these new updated credentials, you'll need to update your build to ensure it's referencing the production credentials. Depending on how you built your integration, you may need to update:

1. API Endpoints or Base URLs

  • Changing to the production environment also involves a different base URL, you will need to update any endpoints referenced in the integration code.

2. Authentication Configurations

  • The API key or secret typically lives in environment variables, config files, or secure vaults (like AWS Secrets Manager, Azure Key Vault).

3. SDK or Client Initialization

  • If you’re using a Corti SDK, you will want to ensure the SDK is referencing the updated credentials (likely using environment variables in 2 above).

💡If you have any questions or concerns please reach out to [email protected]

Did this answer your question?