メインコンテンツまでスキップ

マーケットプレイス版 クイックスタート

Client Credentials 認証でトークンを取得し、SSE 経由でエージェントと会話するまでの手順を解説します。

はじめに

マーケットプレイス版の API を利用するための最短ステップを紹介します。以下の3つのステップでエージェントとの会話を開始できます。

前提条件
  • マーケットプレイスで購入した AgenticStar 環境のセットアップが完了していること
  • 管理画面(Admin)でサービスアカウントを作成済みであること
  • Client ID、Client Secret、Agent ID が手元にあること

Step 1: 認証情報の確認

API 利用前に、以下の情報が揃っていることを確認してください。これらは管理画面で確認できます。

準備チェックリスト

  • マーケットプレイスで購入した AgenticStar 環境のセットアップが完了していること
  • 管理画面(Admin)でサービスアカウントを作成済みであること
  • 以下の情報を取得済みであること:
    • Client ID - サービスアカウントのクライアント ID
    • Client Secret - サービスアカウントのシークレット(Admin 詳細画面で確認)
    • Agent ID - 使用するエージェントの ID

認証情報の例

Client ID: mp-service-001
Client Secret: (hidden)
Agent ID: agent-ai-bot

Step 2: トークン取得

Client Credentials フロー を使用して、アクセストークンを取得します。サーバー側で以下のリクエストを実行してください。

リクエスト例

curl
curl -X POST https://<your-domain>/api/v1/auth/external-service-token \
-H "Content-Type: application/json" \
-d '{
"client_id": "<your-client-id>",
"client_secret": "<your-client-secret>"
}'

パラメータ

  • <your-domain>: Step 1で確認したベース URL(例: api.example.com)
  • <your-client-id>: Step 1で確認したクライアント ID
  • <your-client-secret>: Step 1で確認したシークレット

レスポンス例

JSON
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600
}
トークンの有効期限

expires_in に指定された秒数の間、トークンが有効です。期限切れ前に新しいトークンを取得してください。Client Credentials フローではリフレッシュトークンは発行されないため、期限切れ後は同じリクエストを再度実行してください。

Step 3: Chat API 呼び出し

取得したアクセストークンを使用して、SSE(Server-Sent Events)経由で Chat API を呼び出します。ストリーム形式でエージェントからのリアルタイム応答を受け取ります。

リクエスト例

curl
curl -X POST https://<your-domain>/api/v1/chat/completions \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"model": "AGENTIC STAR",
"stream": true,
"agentId": "<your-agent-id>",
"messages": [
{
"role": "user",
"content": "こんにちは"
}
]
}'

パラメータ

  • <access_token>: Step 2で取得したアクセストークン
  • <your-agent-id>: Step 1で確認したエージェント ID
  • stream: true: SSE ストリーミングを有効化
  • messages: ユーザーからのメッセージ。配列形式で複数メッセージも可能

レスポンス例(SSE ストリーム)

data: {"choices":[{"delta":{"content":"こんにちは"}}]}

data: {"choices":[{"delta":{"content":"、お手伝い"}}]}

data: {"choices":[{"delta":{"content":"できることはありますか"}}]}

data: [DONE]
SSE ストリーミングについて

レスポンスは Server-Sent Events(SSE)形式で、チャンク単位でリアルタイムに送信されます。各チャンクは data: JSON 形式です。data: [DONE] で会話が完了します。詳細はストリーミングガイドを参照してください。

次のステップ

さらに詳しい情報と実装パターンについて、以下のドキュメントを参照してください。