Keyword Insights Support Documentation
  • What is Keyword Insights?
  • learning center
    • Keyword Insights Tool Workflow
    • The Features
      • Keyword Clustering
        • The Advanced Settings
          • Keyword Grouping Accuracy
          • Topical Cluster Creation Method
          • Clustering Types
      • Topical Clusters
      • Competitor Visibility
      • Search Intent/Context
      • Keyword Discovery
      • Content Briefs
      • Writer Assistant
      • AI Writer Agent
    • Freemium Tools
      • SERP Similarity
      • SERP Analyzer
      • Title AI - (Blog Idea Generator)
  • User guide
    • How To Get The $1 Trial
    • How To Build Keyword Lists
      • Using Keyword Discovery
      • Google Search Console (Integration)
      • Using Google Keyword Planner
      • Using Ahrefs/Semrush
      • Google Search Console (Manual)
  • Understanding the output
    • How to Interpret Clusters with In-app Visualisations
    • How to Interpret Clusters in Google Sheets
    • How to Interpret Topical clusters
    • How to Interpret Context/Intent
  • Tool use cases
    • Finding Keyword Cannibalisation (Case study 1)
    • Finding Keyword Cannibalisation (Case study 2)
    • Finding Content Gaps
    • Uncover Keyword Opportunities
    • Find Intent Misalignment
    • Building service level pages
  • Account Management
    • Pricing
      • Subscription
        • Universal Credits Explained
      • Legacy Subscriptions
    • Subscription Management
      • Buying a subscription
      • Cancelling a subscription
      • Refunds
      • Downgrading a subscription
      • Upgrading a subscription
    • Payments & Credit cards
      • Downloading invoices
      • Add or change VAT number
      • Changing billing name or address
      • How to add a backup payment method
      • Changing credit card details
    • Team Management
      • Adding a Team Member
      • Sharing Team Reports
      • Sharing Projects
      • User seats
  • Data retention
    • Data storage and limits
  • ⚙️Integrations
    • Integrations
  • API
    • How to use the Public API?
    • API Use Cases
      • Public API: Clustering
  • FAQs
    • Frequently Asked Questions
  • Help & Support
    • Getting Support
    • Changelog
Powered by GitBook
On this page
  • Prerequisites to use the public API
  • How to use the interactive public API documentation?
  • How to authenticate with the public API and retrieve a bearer token? (Email and password approach)
  • How to authenticate with the public API and retrieve a bearer token? (Google Sign In Approach)
  • Validate your Bearer Token
  1. API

How to use the Public API?

PreviousIntegrationsNextAPI Use Cases

Last updated 7 months ago

Our public API documentation is driven by Swagger and can be accessed .

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 need to 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?

In order to use swagger, you need to be authenticated. See instructions below to do a proper authentication and retrieving a "bearer token".

Once you are authenticated, you can "try out" all available endpoints by inputting the "bearer token" and all required arguments.

How to authenticate with the public API and retrieve a bearer token? (Email and password approach)

This approach is for users who have signed up with email and password instead of Google Sign Up. If you have signed up via "Create with Google" please find instructions in the next section:

  1. When you first open the , scroll to the bottom of the page and locate "Authentication".

You should see a screen similar to this, on which you need to click the "Try it out" button.

  1. Next, the text field below becomes editable.

    1. Enter your valid email address and password, just like you would on the website app.keywordinsights.ai.

    2. Click the large blue "Execute" button below the text field.

If your email and password are correct, you should see a response with a code = 200 and a JSON response object called "result".

  1. From here, copy the value of the "access_token". In the example below, the copied value starts with "eyJ0...." and ends with "...Mokg". You will need this "token" for the next step.

  1. In a text-editor of your choice, paste the copied access token and write the word "Bearer" (with a capital B) in front of the access token, separated with a space. So your complete string should look like this:

Bearer eyJ0e..rest_of_the_token...4AnRMokg

This token is needed to make requests to any endpoint. Some endpoints require additional arguments like "order_id" which you will need to grab from the application. Typically, you can find these IDs in the URL of the respective endpoint.

How to authenticate with the public API and retrieve a bearer token? (Google Sign In Approach)

This approach is for users who have signed up via "Create with Google" instead of typing an email and password into the form during sign up.

  1. In your browser of choice (we use Chrome in this example), open a new tab, and open the "Network" tab in the developer tools.

  2. Click "LOG IN WITH GOOGLE" and follow the prompts in the pop-up window as you normally would when signing in the application.

  3. Once you are logged in, back in the Network tab, scroll up/down until you find a successful request. (We are choosing the /user request, but any other request will also do) Select the request, make sure the "Headers" section on the right-hand panel is selected, and scroll down until you find the "Authorization" section. From here, grab the "Bearer Token". Make sure to copy the entire String, including the word "Bearer".

Validate your Bearer Token

To easily validate if your "Bearer Token" is valid, scroll up to the "User" endpoint and try it out.

  1. Click "Try it out" to make the text field editable.

  2. Copy and paste the bearer token from the step above into the text field

  3. Click the large, blue "Execute" button

  4. If the bearer token was created correctly, you should see a response with a 200 response code and your user object.

Congratulations, you have successfully authenticated with our public API. All endpoints that are documented in the documentation can now be tried out.

How much is the API and how does it calculated?

Alternatively, you can click to get taken directly to the authentication section.

Validate your Bearer Token. Please go to the section to check if you have followed the steps above correctly.

If you have signed up "manually" with an email and password, please find instructions in the previous section:

In the URL bar, type , press enter and before logging in, click the clear button in the Network traffic tab.

Validate your bearer token. Please go to the section: to make sure you copied it correctly.

The API is available for Professional and Premium subscriptions. For clustering, We have a calculation endpoint that will tell you how many credits are needed based on your settings. The API itself has no additional pricing.

this link
app.keywordinsights.ai
here
Validate your Bearer Token
How to authenticate with the public API and retrieve a bearer token? (Email and password approach)
Validate your Bearer Token
here
API documentation
How to authenticate with the public API and retrieve a bearer token? (Google Sign In Approach)
Authentication Section in Keyword Insights - Swagger-Public API
Click the "Try it out" Button to get started using the Public Keyword Insights API
Enter email and password, click execute
Viewing the access token upon successful authentication request.
Finding the Developer Tools in the Google Chrome browser
Opening the "Network Traffic" tab inside the developer tools
Clearing the Network tab to see results of the next step more clearly
Copy the bearer token from a successful request