---
title: はじめに
slug: api-guide/ja/f68l5-uCfUvcvYfTSjuKr
docTags: 
createdAt: 2024-12-16T13:32:41.517Z
---

グラウンドトゥルース生成プロセスをプログラムから操作できるように、HTTP APIを提供しています。このページでは、これらの統合の使用方法、利用可能な機能、および使用される概念と識別子について説明します。

現在の機能は、納品済みアノテーションのレビューに限定されています。

## 前提条件

始める前に、以下がそろっていることを確認してください：

- APIを使用する権限を持つアカウント
- 生成済みのAPI認証情報（[高度な設定](docId\:qTiR2BROmDZhuva3CAtLg)を参照してください）
- 認証用のPython 3 SDKをインストール済み — [kognic-auth](https://pypi.org/project/kognic-auth/)

このページでは以下も前提とします：

- ユーザーが少なくとも1つのプロジェクトにアクセスでき、そのプロジェクトに少なくとも1つのインプットバッチがアップロードされていること。

## APIクライアント

[kognic-io Pythonクライアント](https://pypi.org/project/kognic-io/)は大部分のエンドポイントをカバーしています。カバーされていないエンドポイントについては、kognic-authとrequestsライブラリのみを使用してAPIを利用する方法の例を示します。

## エンドポイント

アクセス可能なエンドポイントの一覧は、[Swaggerドキュメント](https://annotation-integration.app.kognic.com/api)で確認できます。

## リクエスト例

以下は、kognic-authライブラリを使用して、ユーザーが利用可能な[レビュー](docId\:iidcJY1_3wY4Hwg43HKhH)を取得する例です：

```python
import requests

from kognic.auth.requests.auth_session import RequestsAuthSession

base_url = "https://annotation-integration.app.kognic.com/v1/"
client = RequestsAuthSession()

try:
    response = client.session.get(base_url + "reviews/error-types")
    response.raise_for_status()
    data = response.json()
    print(data)
except requests.exceptions.RequestException as e:
    print(f"Request error: {e}")
```