Skip to main content

Introduction

caution

The dataset API is in an early release stage and might be subject to changes.

Prerequisites​

Before you begin, make sure you have:

  • Access to the dataset exploration tool
  • An account with permissions to use our API
  • Generated API credentials. See API Credentials
  • Installed our Python 3 SDK for authentication - kognic-auth

No API Client Available​

At the moment we do not provide an API client for the dataset exploration tool. Instead, we'll provide examples of how you can interact with our API.

Endpoints​

You can discover the list of accessible endpoints within our swagger documentation.

Request Example​

Here's an example using the kognic-auth library to list all datasets available to the user:

import requests

from kognic.auth.requests.auth_session import RequestsAuthSession

client = RequestsAuthSession()

try:
    response = client.session.get("https://dataset.app.kognic.com/v2/datasets")
    response.raise_for_status()
    data = response.json()
    print(data)
except requests.exceptions.RequestException as e:
    print(f"Request error: {e}")

(The v1 version of this endpoint, previously mentioned in this document, is now deprecated)