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

# 仕組みを理解する

> NoimosAI APIの用途、仕組み、Developer Platformとの関係を説明します。

## 概要

APIは、NoimosAIの検索・分析・生成などの機能を、自社サービスや業務システムへ組み込むための方法です。このページでは、APIが適する用途、実行の流れ、Developer Platformとの関係を説明します。

<Note>
  APIは、Developer PlatformでAPI利用が有効になっているプロジェクトを対象とします。通常のNoimosAIワークスペースとは、APIキー、権限、利用履歴、課金残高が分かれています。
</Note>

## APIを使う場面

決まった条件で同じ処理を繰り返す場合や、自社の画面からNoimosAIの機能を呼び出す場合に適しています。APIの使用例は、次のとおりです。

* 自社サービスへ検索やコンテンツ生成を組み込む
* 社内システムから定期的に分析を実行する
* 複数件の入力を独自の順序で処理する
* 実行結果や利用料金を自社側で記録する

ターミナルから直接使う場合は[CLIの基本](/ja/developers/cli/overview)、AIクライアントとの会話から使う場合は[MCPサーバーの基本](/ja/developers/mcp/overview)が適しています。認証や課金先を含む違いは、[開発者向け機能](/ja/developers/overview)で確認できます。

## 実行の流れを理解する

APIで利用する処理には、入力内容や使用するモデルによって料金が変わるものがあります。そのため、有料処理を始める前に無料の見積もりを取得し、最大料金を確認してから実行します。処理の完了を待ち続ける必要はなく、受付時に発行される実行IDで進行状況を確認できます。

基本的な流れは次の5段階です。

1. 利用したいツールと、必要な入力項目を確認します。
2. 実際に処理を始める前に、入力内容に応じた最大料金を無料で見積もります。
3. 見積もりと同じ内容を、確認した上限額を超えない条件で実行します。
4. 受付時に発行された実行IDを使い、完了まで状態を確認します。
5. 完了後に、処理結果と実際に確定した料金を取得します。生成ファイルがある場合は、期限付きURLからダウンロードします。

使用するエンドポイントとリクエスト例は[使い始める](/ja/developers/api/getting-started)で説明します。Developer Platform内の[ドキュメント](https://platform.noimosai.com/docs)でも、現在の見積もり・実行手順を確認できます。

## Developer Platformとの関係を理解する

APIキーは、Developer Platform内の1つのプロジェクトに固定されます。そのキーで作成した実行、利用履歴、前払いUSD残高には、プロジェクトの権限が適用されます。

APIは状態を持たないツール実行を対象としており、通常のNoimosAIワークスペースに保存されたブランド情報や接続済みアカウントを自動では利用しません。入力に必要な文章、公開URL、公開アカウント識別子などは、リクエストで指定します。

## ツールと料金を確認する

利用可能なツール、入力項目、モデル、提供状態、料金は変更される可能性があります。固定した一覧や金額を実装へ埋め込まず、実行時に`GET /tools`と`POST /tools/quote`の結果を確認してください。

## 関連ページ

APIの導入と仕様は、次のページで確認できます。

* [使い始める](/ja/developers/api/getting-started)
* [認証する](/ja/developers/api/authentication)
* [実行と料金を管理する](/ja/developers/api/execution-and-billing)
* [仕様を確認する](/ja/developers/api/reference)