Quick Start

​

Quick Start with NLPearl.AI API

Getting started with the NLPearl.AI API is straightforward. Follow these steps to set up your subscription, create an API secret key, and authenticate your API requests.

​

Step 1: Choose a Subscription

Before you can use the NLPearl.AI API, you need to select a subscription plan that suits your needs. See Billing to view and choose the plan that best fits your requirements.

​

Step 2: Create Your Credentials

To interact with the NLPearl.AI API, you need credentials. Open Settings on the platform, select the API Access page, and create one of the two:

• An API secret key - full access to your workspace, for code you own and run yourself. Store it securely.
• An OAuth 2.0 app - a Client ID and Client Secret with only the scopes you select, for a third-party integration or an app that should reach only part of your workspace.

If you are not sure, start with an API secret key and follow the steps below.

​

Step 3: Find Your Account ID

Your Account ID is required to authenticate with an API secret key. Open Settings, then General Settings, and copy it from the Account ID field. (An OAuth 2.0 app does not need it - the workspace is already part of its access token.)

​

Step 4: Set Up API Authentication

To authenticate your API requests, include your credentials in the header of each request. Check the guide that matches the credentials you created:

​

Conclusion

Starting with the NLPearl.AI API is easy and straightforward. By following these steps, you can quickly set up your account and begin integrating powerful AI capabilities into your applications.