---
title: クイックスタート
slug: api-guide/ja
docTags: 
createdAt: 2024-12-06T10:02:59.645Z
---

Kognicは、Pythonを使用してAPIを簡単に呼び出すためのクライアント「[kognic-io](https://pypi.org/project/kognic-io/)」を提供しています。

## インストール

pipでインストール：

::::Tabs
:::Tab{title="kognic-io"}
最も一般的なユースケース（ファイルのアップロードやプロジェクト管理など）には、`kognic-io`をインストールしてください。

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

:::Tab{title="kognic-auth"}
ファイルのアップロードには不要です。データセットエクスプロレーションまたはアノテーション統合を使用する場合は、`kognic-auth`をインストールしてください。

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

## 認証情報の生成

メインプラットフォームでは、ユーザーメニューのこちらをクリックして認証情報を生成できます。

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

## 認証情報の設定

環境変数`KOGNIC_CREDENTIALS`に認証情報ファイルのパスを設定してください。

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

## 認証情報の確認

認証情報が正しいことを確認するには、Pythonでプロジェクト一覧を取得してください：

:::hint{type="info"}
kognic-io v2.4.0以降、書き込み操作に使用するワークスペースIDを指定できます。複数のワークスペースを持つユーザーの場合、この指定は必須です。
[高度な設定](docId\:qTiR2BROmDZhuva3CAtLg)
:::

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

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

これでKognicプラットフォームと連携する準備が整いました。
:::
::::

## 次のステップ

- [最初のシーンをアップロード](docId\:zmbYD9iYJOMjK8ms-CQoZ): Kognicプラットフォームへのデータアップロードのクイックガイド