Skip to main content
Our public API is documented with Swagger and can be accessed at https://api.keywordinsights.ai/apidocs.

​
Prerequisites to use the public API

You need to have a valid Keyword Insights subscription in order to use the public API. Before using the public API, you must acquire a Bearer token for authentication so that our servers can verify who you are and that you have permission to use the API.

​
How to use the interactive public API documentation

To use the Swagger UI interactively, you must first be authenticated.
Follow the instructions below to generate a Bearer token. Once you are authenticated, you can Try it out on any endpoint by providing your Bearer token and the required parameters.

​
Authenticate and retrieve a Bearer token (email and password)

This approach is for users who signed up with an email and password (not via Google Sign In).
If you signed up with Create with Google, use the Google Sign In approach in the next section instead:
How to authenticate with the public API and retrieve a bearer token? (Google Sign In Approach)
  1. Open the API documentation, scroll to the bottom of the page, and locate the Authentication section.
Authentication section in Keyword Insights Swagger public API Alternatively, you can go directly to the authentication endpoint using this link:
Authentication → /authentication/login You should now see the authentication request details, including a Try it out button. Click the Try it out button to get started using the Keyword Insights public API
  1. After clicking Try it out, the request body field becomes editable.
    1. Enter your valid email address and password, exactly as you would on app.keywordinsights.ai.
    2. Click the large blue Execute button below the text field.
Enter email and password, then click Execute If your email and password are correct, you should see a 200 response code and a JSON response object containing a result object.
  1. In the response, copy the value of the access_token.
    In the example below, the token starts with eyJ0.... and ends with ...Mokg. You will need this token in the next step.
Viewing the access token upon a successful authentication request
  1. In a text editor of your choice, paste the copied access token and prepend the word Bearer (with a capital B), separated by a single space.
    Your complete string should look similar to:
Bearer eyJ0e..rest_of_the_token...4AnRMokg
This full string (including the word Bearer) is what you will use as the Authorization header for any authenticated API request.
Some endpoints also require additional arguments such as order_id, which you can usually find in the URL of the respective page in the application.
  1. Validate your Bearer token using the steps in the section
    Validate your Bearer Token.

​
Authenticate and retrieve a Bearer token (Google Sign In)

Use this approach if you signed up using Create with Google instead of creating a password during sign up. If you signed up manually with an email and password, use the previous section instead:
How to authenticate with the public API and retrieve a bearer token? (Email and password approach)
  1. In your browser of choice (Chrome in this example), open a new tab and open the Network tab in the developer tools.
Opening the developer tools in Google Chrome Opening the Network tab in the Chrome developer tools
  1. In the address bar, navigate to https://app.keywordinsights.ai.
    Before logging in, click the clear button in the Network tab so that you can easily see only the upcoming requests.
Clearing the Network tab to more easily inspect the next requests
  1. Click LOG IN WITH GOOGLE and follow the prompts in the pop-up window as you normally would when signing in to the application.
  2. After you are logged in, go back to the Network tab and locate a successful request (for example, the /user request – but any authenticated request will work).
    • Select the request.
    • In the right-hand panel, make sure the Headers tab is selected.
    • Scroll down until you find the Authorization header.
    • Copy the entire value of the Authorization header, including the word Bearer.
Copying the Bearer token from an authenticated request in the Network tab
  1. Validate your Bearer token using the steps in
    Validate your Bearer Token.

​
Validate your Bearer Token

To confirm that your Bearer token works correctly, you can call the User endpoint in Swagger.
  1. In the Swagger UI, navigate to the User endpoint and click Try it out to make the input fields editable.
  2. Paste the full Bearer token string (including the word Bearer) into the appropriate field.
  3. Click the large blue Execute button.
Entering the Bearer token to validate it via the User endpoint Executing the request to validate the Bearer token
  1. If the Bearer token is valid, you should see a 200 response code and your user object in the response body.
Successful response when validating the Bearer token Congratulations! You have successfully authenticated with our public API. You can now call any endpoint documented in the API reference.