---
title: "API概要"
description: "マインドのプログラムによる操作とナレッジ管理を可能にするMinds APIの概要。"
---

# API概要

Minds APIドキュメントへようこそ。当社のAPIを使用すると、AIマインドの作成と管理、ナレッジのアップロード、およびそれらとのインタラクションをプログラムから実行できます。

## はじめに

Minds APIはREST原則に基づいて設計されています。当社のAPIは予測可能なリソース指向のURLを採用し、JSONエンコードされたリクエストボディを受け付け、JSONエンコードされたレスポンスを返し、標準的なHTTPレスポンスコード、認証、メソッドを使用します。

### ベースURL

**本番環境:** `https://getminds.ai/api/v1` または `https://api.getminds.ai/v1`

**ローカル開発環境:** `http://localhost:3000/api/v1`

どちらの本番環境ベースURLも完全に等価です。よりシンプルな連携URLにするために、`api.getminds.ai`サブドメインの使用を推奨します。

### 認証

すべてのAPIエンドポイントで、APIキーによる認証が必要です。APIキーは[Settings → API Keys](/settings/api-keys)で生成および管理できます。

`Authorization`ヘッダーにAPIキーを含めてください：

```bash
Authorization: Bearer minds_your_api_key_here
```

### OpenAPI仕様

マシンリーダブルなOpenAPI 3.1.0仕様が[`/_openapi.json`](/_openapi.json)で公開されています。この仕様を使用して、型定義されたクライアント（TypeScript、Pythonなど）を生成したり、LLMに読み込ませてワンショットで連携コードを生成したりできます。例については[OpenAPI](/docs/api/openapi)を参照してください。

### コンテンツタイプ

データを送信するすべてのリクエストには、`Content-Type`ヘッダーを含める必要があります：

```bash
Content-Type: application/json
```

ファイルのアップロードには以下を使用します：

```bash
Content-Type: multipart/form-data
```

## 利用可能なエンドポイント

### Minds

カスタム設定を持つAIマインド（エージェント）を作成および管理します。

- `GET /api/v1/minds` - すべてのMindを一覧表示
- `GET /api/v1/minds/{mindId}` - Mindの詳細を取得
- `POST /api/v1/minds` - 新規Mindを作成
- `PUT /api/v1/minds/{mindId}` - Mindを更新
- `DELETE /api/v1/minds/{mindId}` - Mindを削除
- `POST /api/v1/minds/{mindId}/regenerate-prompt` - ナレッジからシステムプロンプトを再生成
- `GET /api/v1/minds/{mindId}/patterns` - Mindの生の思考パターンを取得

### Knowledge

マインドのナレッジを管理します。

- `GET /api/v1/minds/{mindId}/knowledge` - ナレッジアイテムを一覧表示
- `POST /api/v1/minds/{mindId}/knowledge` - ナレッジを追加（リンク、ファイル、またはキーワード検索）
- `PUT /api/v1/minds/{mindId}/knowledge/{itemId}` - ナレッジアイテムを更新
- `DELETE /api/v1/minds/{mindId}/knowledge/{itemId}` - ナレッジアイテムを削除
- `POST /api/v1/minds/{mindId}/knowledge/enrich` - キーワード検索によるエンリッチ（便利なエイリアス）
- `GET /api/v1/minds/{mindId}/knowledge/patterns` - フレームワークごとのナレッジパターンを取得

### Chat

チャット補完を介してマインドとインタラクションを行います。

- `POST /api/v1/minds/{mindId}/completion` - メッセージを送信してレスポンスを取得

### Studies

マインドのグループを調査するためのAIパネルを作成および管理します。

- `GET /api/v1/studies` - すべてのパネルを一覧表示
- `POST /api/v1/studies` - 新規パネルを作成
- `GET /api/v1/studies/{studyId}` - メッセージ履歴を含むパネルの詳細を取得
- `POST /api/v1/studies/{studyId}/ask` - パネル内のすべてのマインドに質問を送信（SSEストリーム）
- `POST /api/v1/studies/{studyId}/export` - パネル結果をレポートとしてエクスポート
- `GET /api/v1/studies/{studyId}/export-status` - エクスポートジョブのステータスを確認
- `GET /api/v1/studies/{studyId}/export-download` - エクスポートされたPDFをダウンロード

### User

ユーザー関連のエンドポイント。

- `GET /api/v1/auth/me` - 現在認証されているユーザーを取得
- `GET /api/v1/user/shareable-sparks` - 共有可能なマインドを一覧表示

### APIキー

認証用のAPIキーを管理します。

- `GET /api/v1/api-keys` - APIキーを一覧表示
- `POST /api/v1/api-keys` - 新規APIキーを作成
- `DELETE /api/v1/api-keys/{keyId}` - APIキーを削除

## クイックサンプル

以下は、マインドを作成してチャットを行う簡単な例です：

```bash
# 1. Create a mind (keywords mode)
curl -X POST "https://getminds.ai/api/v1/minds" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Marketing Expert",
    "description": "Expert in digital marketing strategies",
    "mode": "keywords",
    "type": "expert",
    "discipline": "Marketing",
    "keywords": ["SEO", "content marketing", "social media", "analytics"]
  }'

# Response: { "data": { "id": "mind-id", ... }, "processing": { "queued": true, ... } }

# 2. Create a mind from social profile (clone mode)
curl -X POST "https://getminds.ai/api/v1/minds" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Influencer Clone",
    "description": "AI trained on influencer social presence",
    "mode": "clone",
    "type": "creative",
    "discipline": "Social Media Marketing",
    "personaContext": "https://twitter.com/username"
  }'

# 3. Chat with the mind
curl -X POST "https://getminds.ai/api/v1/minds/mind-id/completion" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "role": "user",
        "content": "What are the top social media trends for 2025?"
      }
    ]
  }'
```

## 次のステップ

- [認証](/docs/api/authentication)について学ぶ
- [Mindsエンドポイント](/docs/api/minds)を探索する
- [ナレッジ管理](/docs/api/knowledge)について読む
- [チャット補完](/docs/api/chat)を理解する
- 複数マインドの調査用に[パネル](/docs/api/studies)を作成する
- [レイテンシーとパフォーマンス](/docs/api/latency)を確認する
- [MCP連携](/mcp/overview)経由で接続する
- [エラーと制限](/docs/api/errors)を確認する

## プラン制限

APIおよびMCPアクセスは、対応する有料プランで利用できます。制限を連携側にハードコードせず、構造化された`plan_limited`および`429`レスポンスを処理してください。IndividualプランはAPI payloadでは`"premium"`と表示されます。

以下の公開デフォルト値は、製品と同じプラン制限・機能アクセス契約から生成されます。製品に表示されるアカウント固有またはEnterprise契約のオーバーライドが優先されます。

:plan-limits-table[プランを表示](/settings?tab=subscription)

## お困りですか？

APIに関するご質問やサポートが必要な場合は、以下をご利用ください：

- [ガイド](/guide)を確認する
- フィードバックフォームから問い合わせる
- コミュニティディスカッションに参加する