Skip to main content

Authorization

Follow this guide to create a new OpenAI credential that will allow Nexla to authenticate to and exchange data with your OpenAI account.
openai_api_auth.png

Open AI

Prerequisites​

Before creating an OpenAI credential, you need to obtain your API key from your OpenAI account. OpenAI uses API key authentication for all API requests, with the API key sent in the Authorization header with the Bearer prefix.

To obtain your OpenAI API key, follow these steps:

  1. Sign in to your OpenAI account, or create a new account at OpenAI.

  2. Navigate to your account dashboard or profile settings in the OpenAI interface.

  3. Click on your profile icon or account name in the top right corner, and select API keys or navigate to Settings > API keys.

  4. If you don't have an API key yet, click Create new secret key or + Create new secret key to create a new API key.

  5. Configure your API key settings:

    • Enter a name for the API key (e.g., "Nexla Integration")
    • Review and select the permissions or scopes for the key (if applicable)

  6. Click Create secret key to create the API key.

  7. Copy the API key immediately after it's generated, as it may not be accessible again after you navigate away from the page. The API key will be displayed only once.

  8. Store the API key securely, as you will need it to configure your Nexla credential. The API key is sensitive information and should be kept confidential.

The API key is sent in the Authorization header with the Bearer prefix (e.g., Authorization: Bearer {api_key}) for all API requests to the OpenAI API. The API key authenticates your requests and grants access to OpenAI resources based on your account plan and usage limits. If your API key is compromised, you should immediately revoke it in your OpenAI account settings and generate a new one. For detailed information about obtaining API keys, API authentication, and available endpoints, refer to the OpenAI API documentation.

Create an OpenAI Credential​

  • To create a new OpenAI credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – OpenAI

OpenAICred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

OpenAI uses API key authentication for all API requests. The API key is sent in the Authorization header with the Bearer prefix to authenticate API requests to the OpenAI API.

  1. Enter your OpenAI API key in the API Key Value field. This is the API key you obtained from your OpenAI account settings (API keys section). The API key is sent in the Authorization: Bearer {api_key} header for all API requests to the OpenAI API. The API key is sensitive information and must be kept confidential.

    Your OpenAI API key can be found in your OpenAI account settings under the API keys section (Settings > API keys). The API key is sent in the Authorization: Bearer {api_key} header for all API requests to the OpenAI API.

    If your API key is compromised, you should immediately revoke it in your OpenAI account settings and generate a new one. The API key provides access to your OpenAI account and should be treated as sensitive information. Keep your API key secure and do not share it publicly.

    For detailed information about obtaining API keys, API authentication, and available endpoints, see the OpenAI API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.