> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryprofound.com/llms.txt
> Use this file to discover all available pages before exploring further.

# はじめに

> REST API とその機能の概要

<Info>
  **利用可能なプラン**: Enterprise プラン
</Info>

## 概要

API を使用すると、開発者はプラットフォームに表示されるデータをプログラムから操作できます。すべての API レスポンスは JSON 形式で返されるため、最新のアプリケーションやツールと簡単に連携できます。

### ベース URL

すべての API リクエストは次の URL に送信します。

```
https://api.tryprofound.com
```

**主な機能:**

* データの取得と処理タスクの自動化
* サードパーティアプリケーションとの連携の構築
* カスタムレポートと分析の生成
* 処理済みレポートおよび実行ごとの生のプロンプト回答データへのアクセス

## API の機能

### レポート生成

プロンプトシステムから得られた処理済みデータを使用して、包括的なレポートを作成できます。さまざまな企業、期間、評価基準でパフォーマンス指標を比較し、データからインサイトを得られます。

### 実行ごとの生データ

`POST /v2/prompts/answers` を通じて、実行ごとの生のプロンプト回答行にアクセスできます。
これには、モデルの回答、言及、引用、
検索クエリが含まれます。

### ユーザー単位のアクセス

各 API キーは、それを作成したユーザーに属する個人用アクセストークンです。キーを使用して行われたリクエストはそのユーザーに帰属し、そのユーザーが所属する組織のデータにのみアクセスできます。詳細については、[キーの所有権](/ja-jp/rest-api/authentication#key-ownership) を参照してください。

## はじめかた

API の使用を開始するには、プラットフォームのユーザープロフィールから API キーを取得する必要があります。このキーはリクエストをあなた自身として認証し、あなたが所属する組織のデータへのアクセスを許可します。

認証の詳細とリクエスト例については、次を参照してください。

* [認証](/ja-jp/rest-api/authentication) - リクエストを認証する方法
* [期間とタイムゾーン](/ja-jp/rest-api/date-ranges) - 日付パラメータとタイムゾーンの扱いについて
* [リクエスト例](/ja-jp/rest-api/examples/example) - API 呼び出しとレスポンスのサンプル
  * [Answer Engine Insights](/ja-jp/rest-api/examples/answer-engine-insights)
  * [Agent Analytics](/ja-jp/rest-api/examples/agent-analytics)
  * [Agents](/ja-jp/rest-api/examples/agents)

## API の基本

### データの構成

各組織は、特定のカテゴリとデータセットにアクセスできます。`/v1/org` エンドポイントを使用して、次のことができます。

* 利用可能なデータカテゴリを確認する
* フィルタリング用の識別子を取得する
* データの範囲と権限を把握する

### 必須パラメータ

Answer Engine Insights のレポートには、**カテゴリ識別子** と
**期間パラメータ** (`start_date` と `end_date`) が必要です。ボットおよびリファラルの
トラフィックレポートは、代わりにドメイン単位で指定します。正しい形式については [期間と
タイムゾーン](/ja-jp/rest-api/date-ranges) を参照してください。

### API のバージョニング

API には現在 `v1` と `v2` の両方のエンドポイントがあります。

* `v1` エンドポイントは、既存の V1 レポートエンドポイントを含め、引き続き利用できます
* `v2` は現在、`/v2/reports/visibility`、`/v2/reports/citations`、
  `/v2/reports/sentiment`、`/v2/reports/query-fanouts`、
  `/v2/reports/factcheck`、`/v2/reports/factcheck/claims` の Answer Engine Insights レポートと、
  `/v2/prompts/answers` をカバーしています。それぞれに `/stream` の SSE バリアントがあります。

バージョン付きのパスにより、API が進化しても互換性が保たれます。

## レート制限

**デフォルトの制限:** API キーごとに 1 時間あたり 600 リクエスト。

### レート制限ヘッダー

すべての API レスポンスには、次のヘッダーが含まれます。

* `X-RateLimit-Limit`: リクエストの上限数
* `X-RateLimit-Remaining`: 現在の期間内の残りリクエスト数
* `X-RateLimit-Reset`: 制限がリセットされる時刻 (Unix タイムスタンプ)

### レート制限への対処

制限を超えると、`429 Too Many Requests` エラーが返されます。レスポンスには、再試行までの待機時間を示す `Retry-After` ヘッダーが含まれます。

より高い制限が必要な場合は、サポートチームにご相談ください。

## レスポンス形式

すべての API レスポンスは JSON 形式を使用し、エラーと成功時のレスポンスで一貫した構造になっています。
