Authentication

The Konver API uses API keys to authenticate requests. This guide explains how to obtain and use your API key.

Obtaining an API Key

1. Log in to your Konver account
2. Navigate to Organization → Developer → API Keys
3. Click Create API Key
4. Give your key a descriptive name (e.g., "Production Integration")
5. Copy the generated key immediately — it will only be shown once

Keep Your API Key Secret

Your API key grants access to your organization's data. Never share it publicly or commit it to version control. If your key is compromised, revoke it immediately and create a new one.

Using Your API Key

Include your API key in the X-Api-Key header of every request:

X-Api-Key: YOUR_API_KEY

Example Request

cURL

curl -X GET "https://api.konver.ai/v1/company/{id}" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch('https://api.konver.ai/v1/company/{id}', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();

Python

import requests

headers = {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.get(
  'https://api.konver.ai/v1/company/{id}',
    headers=headers
)

data = response.json()

C#

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.GetAsync("https://api.konver.ai/v1/company/{id}");
var content = await response.Content.ReadAsStringAsync();

Environment Variables

We recommend storing your API key in environment variables rather than hardcoding it:

Bash

export KONVER_API_KEY="your_api_key_here"

.env file

KONVER_API_KEY=your_api_key_here

Then access it in your code:

JavaScript

const apiKey = process.env.KONVER_API_KEY;

Python

import os
api_key = os.environ.get('KONVER_API_KEY')

C#

var apiKey = Environment.GetEnvironmentVariable("KONVER_API_KEY");

Revoking API Keys

If an API key is compromised or no longer needed:

1. Go to Organization → Developer → API Keys
2. Find the key in the list
3. Click the Revoke button
4. Confirm the action

warning

Revoking an API key takes effect immediately. Any applications using the key will stop working.

Troubleshooting

401 Unauthorized

If you receive a 401 Unauthorized response:

• Verify your API key is correct and hasn't been revoked
• Ensure the X-Api-Key header is formatted correctly: X-Api-Key: YOUR_API_KEY
• Check that there are no extra spaces or characters in the key

403 Forbidden

If you receive a 403 Forbidden response:

• Your API key doesn't have permission for the requested operation
• Contact your organization admin to grant additional permissions

Next Steps

Now that you have authentication set up, try making your first API call:

• Quickstart Guide — Make your first API request
• API Reference — Explore all available endpoints