---
title: Quickstart
slug: api-guide
docTags: 
createdAt: 2024-12-06T10:02:59.645Z
---

Kognic provides a client called [kognic-io](https://pypi.org/project/kognic-io/) to simplify calling our APIs using Python.

## Installation

Install via pip:

::::Tabs
:::Tab{title="kognic-io"}
Install `kognic-io` for the most common use cases like file uploads and project management.

```bash
pip install --upgrade kognic-io
```
:::

:::Tab{title="kognic-auth"}
Not needed for file uploads. Install `kognic-auth` if you intend to use Dataset exploration or Annotation integration.

```bash
pip install --upgrade kognic-auth
```

 
:::
::::

## Generating credentials

In the main platform, credentials can be generated by clicking here in the user menu.

::Image[]{src="https://api.archbee.com/api/optimize/wLEz_RbWP6nIMpY-prjlm/G6e0fG28Y_oKoaAHuu_A__creds-en.png" size="60" isUploading="false" position="center" width="470" height="298" darkWidth="470" darkHeight="298" showCaption="false"}

## Setting credentials

Set the environment variable `KOGNIC_CREDENTIALS` to point to it.

```bash
export KOGNIC_CREDENTIALS=~/path/to/credentials.json
```

## Verify credentials

To verify that they are correct you can simply list projects in Python:

:::hint{type="info"}
Since kognic-io v2.4.0 you can provide a workspace id that will be used for writes.
For users with multiple workspaces this will be mandatory.   [See this page for instructions.](docId\:xMGM2k-Teox9jtN_otqBM) 
:::

::::Tabs
:::Tab{title="kognic-io"}
```python
from kognic.io.client import KognicIOClient

client = KognicIOClient()
client.project.get_projects()
print("success")
```

You should now be set up to interact with the Kognic Platform.
:::
::::

## Next step

- [Upload your first scene](docId\:aEWTqKrztf5ZoO5sAsyDv): Quick guide on how to upload data to the Kognic Platform