NOIMOSAI / API PLATFORM

ドキュメント

API専用の認証と、開発者プロジェクトのアクセス管理。

権限のしくみ

01 / AUTHENTICATION

APIキーで認証する

nmp_で始まる開発者キーをサーバー側の環境変数に保存し、共通ツールAPIのAuthorizationヘッダーにBearer形式で指定します。キーに紐づくプロジェクトの権限とUSD残高が適用されます。

APIキーを管理 →

02 / REQUEST FORMAT

最初のリクエスト

共通ツールAPIのURLと開発者キーを環境変数に設定し、接続先のプロジェクトを確認します。

cURL

curl "$NOIMOS_PLATFORM_API_URL/tools/project" \
  -H "Authorization: Bearer $NOIMOS_PLATFORM_API_KEY"

curl "$NOIMOS_PLATFORM_API_URL/tools/usage" \
  -H "Authorization: Bearer $NOIMOS_PLATFORM_API_KEY"

プロジェクト・使用量の参照は無料で履歴に記録されます。見積もりとカタログの参照も無料です。現在のツール・提供状況・USD料金はツール画面で確認できます。

HTTP	アクセス権限	内容	リクエスト料金
`GET /tools/project`	`project:read`	APIキーに紐づく開発者組織・プロジェクト	$0
`GET /tools/usage`	`usage:read`	現在のプロジェクトの月間リクエスト数・使用額	$0
`GET /tools`	`tools:read`	ツール一覧・入力形式・USD料金	$0
`POST /tools/quote`	`tools:read`	外部処理を開始しない無料見積もり	$0
`POST /tools/{tool}`	`tools:execute`	前払い残高を予約して有料処理を登録	見積もりに従う
`GET /tools/executions/{id}`	`executions:read`	実行状態・出力・確定料金	$0
`POST /tools/executions/{id}/cancel`	`tools:execute`	未開始の処理を停止。発生済みの費用は精算	$0
`GET /tools/executions/{id}/artifacts/{artifactId}/download`	`executions:read`	最大5分間有効な非公開ファイルURL	$0

03 / EXECUTION

見積もりと実行

無料見積もりのpriceVersionとmaximumChargeMicrosをリクエストファイルへ転記し、このリクエスト用のUUIDを設定・保持してください。送信すると前払い残高を使用します。再送時は同じファイルとUUIDを使い、状態確認は5秒以上空けてください。needs_reviewでは照合が完了するまで予約を保持します。

platform-execution-request.json

{
  "tool": "web_search",
  "arguments": {
    "query": "content marketing"
  },
  "priceVersion": "COPY_FROM_QUOTE",
  "maximumChargeMicros": 10000
}

cURL

curl "$NOIMOS_PLATFORM_API_URL/tools/quote" \
  -H "Authorization: Bearer $NOIMOS_PLATFORM_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"tool":"web_search","arguments":{"query":"content marketing"}}'

curl "$NOIMOS_PLATFORM_API_URL/tools/web_search" \
  -H "Authorization: Bearer $NOIMOS_PLATFORM_API_KEY" \
  -H "Idempotency-Key: $PLATFORM_REQUEST_UUID" \
  -H "Content-Type: application/json" \
  --data @platform-execution-request.json

curl "$NOIMOS_PLATFORM_API_URL/tools/executions/$PLATFORM_EXECUTION_ID" \
  -H "Authorization: Bearer $NOIMOS_PLATFORM_API_KEY"

ツール・実行画面 →

04 / ERRORS & LIMITS

エラーと利用上限

`401`	APIキーが無効、失効済み、または期限切れです。認証情報を確認してください。
`403`	この開発者プロジェクトや操作への権限がありません。プロジェクトの権限を確認してください。
`429`	リクエスト上限に達しました。時間をおいて、間隔を延ばしながら再試行してください。