Agent Studio

Agent Studio APIを使用すると、Genie、ナレッジベース、スキルなどのAgent Studioアセットをプログラムで作成および管理できます。

レート制限

Agent Studioリソースには、次のレート制限があります:

タイプ	リソース	制限
GET	Genieを一覧表示: /api/agentic/genies	1分あたり1,000リクエスト
GET	IDでGenieを取得: /api/agentic/genies/:id	1分あたり1,000リクエスト
GET	すべての Genie会話エンドポイント	1秒あたり10リクエスト
すべて	その他すべてのGenieエンドポイント	1分あたり60リクエスト
GET	ナレッジベースを一覧表示: /api/agentic/knowledge_bases	1分あたり1,000リクエスト
GET	IDでナレッジベースを取得: /api/agentic/knowledge_bases/:id	1分あたり1,000リクエスト
すべて	その他すべてのナレッジベースエンドポイント	1分あたり60リクエスト
GET	スキルを一覧表示: /api/agentic/skills	1分あたり1,000リクエスト
GET	IDでスキルを取得: api/agentic/skills/:id	1分あたり1,000リクエスト
すべて	その他すべてのスキルエンドポイント	1分あたり60リクエスト

クイックリファレンス

タイプ	リソース	説明
GET	/api/agentic/genies	Genieのリストを返します。
POST	/api/agentic/genies	新しいGenieを作成します。
PUT	/api/agentic/genies/:id	既存のGenieを更新します。
GET	/api/agentic/genies/:id	指定したIDに関連付けられているGenieを返します。
DELETE	/api/agentic/genies/:id	Genieを削除します。
POST	/api/agentic/genies/:id/start	指定したIDに関連付けられているGenieを開始します。
POST	/api/agentic/genies/:id/stop	指定したIDに関連付けられているGenieを停止します。
POST	/api/agentic/genies/:id/assign_skills	指定したIDに関連付けられているGenieにスキルを割り当てます。
POST	/api/agentic/genies/:id/remove_skills	指定したIDに関連付けられているGenieからスキルを削除します。
POST	/api/agentic/genies/:id/assign_knowledge_bases	指定したIDに関連付けられているGenieにナレッジベースを割り当てます。
POST	/api/agentic/genies/:id/remove_knowledge_bases	指定したIDに関連付けられているGenieからナレッジベースを削除します。
POST	/api/agentic/genies/:id/assign_user_groups	指定したIDに関連付けられているGenieにユーザーグループアクセスを割り当てます。
POST	/api/agentic/genies/:id/remove_user_groups	指定したIDに関連付けられているGenieからユーザーグループアクセスを削除します。
GET	/api/agentic/genies/clients	Genieクライアントのリストを返します。
POST	/api/agentic/genies/clients	新しいGenieクライアント（APIキーまたはOAuth）を作成します。
PUT	/api/agentic/genies/clients/:client_id	Genieクライアントの名前を更新します。
DELETE	/api/agentic/genies/clients/:client_id	Genieクライアントを削除します。
POST	/api/agentic/genies/clients/:client_id/regenerate	GenieクライアントのAPIキーを再生成します。
POST	/api/agentic/genies/:id/clients	クライアントをGenieにアタッチします。
DELETE	/api/agentic/genies/:id/clients/:client_id	クライアントをGenieからデタッチします。
GET	/api/agentic/genies/:genie_id/conversations	Genieの会話のリストを返します。イベントレベルの詳細は含まれません。
GET	/api/agentic/genies/:genie_id/conversations/:conversation_id	指定したGenieの会話を返します。イベントレベルの詳細は含まれません。
GET	/api/agentic/genies/:genie_id/conversations/:conversation_id/events	1つの会話のすべてのイベントを返します。
GET	/api/agentic/genies/:genie_id/guardrails	指定したIDに関連付けられているGenieのガードレールとそのポリシーを返します。
PUT	/api/agentic/genies/:genie_id/guardrails/policies/:policy_type	指定したIDに関連付けられているGenieで、単一のガードレールポリシーを作成または更新します。
GET	/api/agentic/genies/guardrails/policies/pii_entities	`pii_detection`ポリシーで使用できるPIIエンティティタイプ文字列のリストを返します。
GET	/api/agentic/knowledge_bases	ナレッジベースのリストを返します。
POST	/api/agentic/knowledge_bases	新しいナレッジベースを作成します。
GET	/api/agentic/knowledge_bases/:id	指定したIDに関連付けられているナレッジベースを返します。
PUT	/api/agentic/knowledge_bases/:id	既存のナレッジベースを更新します。
DELETE	/api/agentic/knowledge_bases/:id	ナレッジベースを削除します。
GET	/api/agentic/knowledge_bases/:id/data_sources	指定したナレッジベースIDに関連付けられているデータソースを返します。
GET	/api/agentic/knowledge_bases/:id/recipes	指定したナレッジベースIDに関連付けられているレシピを返します。
GET	/api/agentic/skills	スキルのリストを返します。
POST	/api/agentic/skills	新しいスキルを作成します。
GET	/api/agentic/skills/:id	指定したIDに関連付けられているスキルを返します。

Genie

Agent StudioのGenieは、次のエンドポイントと構成をサポートしています：

Genieの一覧表示

Genieのリストを返します。

GET https://YOUR_DATA_CENTER/api/agentic/genies

クエリパラメーター

名前	タイプ	説明
folder_id	string 任意	Genieが存在するフォルダのID。
project_id	string 任意	Genieが存在するプロジェクトのID。
state	string 任意	Genieの状態。例: `active`または`inactive`。
page	integer 任意	取得するGenieのページ番号。最小値は`1`です。
per_page	integer 任意	1ページで返すGenieの数。最小値は`1`です。最大値は`50`です。

サンプルリクエスト

shell

curl  -X GET https://YOUR_DATA_CENTER/api/agentic/genies?per_page=:per_page_value&page=:page_value \
      -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

チャネル構成フィールドは常に返され、明示的な構成が設定されていない場合はデフォルト値が使用されます。

json

[
  {
      "id": "gin-BWLSPX4z-BaT3D9",
      "name": "Customer Support Genie",
      "description": "Handles customer support inquiries and provides quick responses.",
      "state": "stopped",
      "folder_id": 22991030,
      "instructions": "You are a helpful, friendly support agent who answers customer questions clearly and politely.",
      "ai_provider": "open_ai",
      "chat_interface": "slack",
      "channel_mode": "dms_only",
      "channel_scope": "specific",
      "response_mode": "on_mention",
      "channel_whitelist": [],
      "skills_count": 5,
      "knowledge_bases_count": 3,
      "user_groups_count": 0,
      "active_recipes_count": 0,
      "inactive_skills_count": 5,
      "logo_url": "https://example.com/logo.png",
      "created_at": "2025-07-15T11:07:34.060-07:00",
      "updated_at": "2026-02-24T08:38:29.099-08:00"
  },
  {
      "id": "gin-ZWSMPR4a-TaG7S9",
      "name": "Customer Support Genie v2",
      "description": "Updated to handle billing inquiries in addition to general support.",
      "state": "stopped",
      "folder_id": 21285720,
      "instructions": "You are a knowledgeable, polite support assistant. Always prioritize clear, concise answers.",
      "ai_provider": "open_ai",
      "chat_interface": "slack",
      "channel_mode": "everywhere",
      "channel_scope": "all_invited",
      "response_mode": "helpdesk",
      "channel_whitelist": [],
      "skills_count": 5,
      "knowledge_bases_count": 3,
      "user_groups_count": 0,
      "active_recipes_count": 0,
      "inactive_skills_count": 5,
      "logo_url": "https://example.com/logo.png",
      "created_at": "2026-02-24T08:54:34.585-08:00",
      "updated_at": "2026-02-25T09:34:14.013-08:00"
  }
]

Genieを作成する

新しいGenieを作成します。

POST https://YOUR_DATA_CENTER/api/agentic/genies

ペイロード

名前	タイプ	説明
name	string 必須	Genieの名前。
説明	string 必須	Genieの目的の説明。
folder_id	string 必須	Genieが存在するフォルダのID。
instructions	string 必須	Genieが目的、パーソナリティ、ジョブの説明を識別するために使用する指示。
ai_provider	string 必須	Genieを動作させるAIプロバイダー。使用できる値は`anthropic`または`open_ai`です。
shared_account_id	integer 必須	GenieのコネクションID。
custom_oauth_key_id	integer 必須	カスタムOAuthキーID。
matrix	boolean 必須	Workato GOをチャットインターフェイスとして有効にするかどうかを決定します。使用できる値は`true`または`false`です。
channel_mode	string 任意	Genieが応答する場所を制御します。使用可能な値は`dms_only`または`everywhere`です。デフォルトは`dms_only`です。
channel_scope	string 任意	Genieが応答するチャネルを決定します。使用可能な値は`specific`または`all_invited`です。デフォルトは`specific`です。
response_mode	string 任意	Genieがチャネルでトリガーされる方法を制御します。使用可能な値は`on_mention`または`helpdesk`です。デフォルトは`on_mention`です。
channel_whitelist	string[] 任意	Genieによる応答が許可されているSlackチャネルIDの配列です。 `channel_scope`が`specific`の場合にのみ適用されます。デフォルトは`[]`です。

サンプルリクエスト

shell


curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "name": ":genie_name",
           "description": ":description",
           "folder_id": ":folder_id",
           "instructions": ":instructions",
           "ai_provider": ":ai_provider",
           "shared_account_id": :shared_account_id,
           "custom_oauth_key_id": :custom_oauth_key_id,
           "matrix": :true_or_false,
           "channel_mode": ":channel_mode",
           "channel_scope": ":channel_scope",
           "response_mode": ":response_mode",
           "channel_whitelist": [":channel_id", ":channel_id"]
         }'

サンプルレスポンス

json

{
  "id": "gin-BWLSPX4z-BaT3D9"
}

Genieを更新

既存のGenieを更新します。

PUT https://YOUR_DATA_CENTER/api/agentic/genies/:id

クエリパラメータ

名前	タイプ	説明
id	string 必須	更新するGenieのID。
name	string 任意	Genieの名前。
説明	string 任意	Genieの目的の説明。
folder_id	string 任意	Genieが存在するフォルダのID。
instructions	string 任意	Genieが目的、パーソナリティ、ジョブの説明を識別するために使用する指示。
ai_provider	string 任意	Genieを動作させるAIプロバイダー。使用できる値は`anthropic`または`open_ai`です。
shared_account_id	integer 任意	GenieのコネクションID。
custom_oauth_key_id	integer 任意	カスタムOAuthキーID。
matrix	boolean 任意	Workato GOをチャットインターフェイスとして有効にするかどうかを決定します。使用できる値は`true`または`false`です。
channel_mode	string 任意	Genieが応答する場所を制御します。使用可能な値は`dms_only`または`everywhere`です。
channel_scope	string 任意	Genieが応答するチャネルを決定します。使用可能な値は`specific`または`all_invited`です。
response_mode	string 任意	Genieがチャネルでトリガーされる方法を制御します。使用可能な値は`on_mention`または`helpdesk`です。
channel_whitelist	string[] 任意	Genieによる応答が許可されているSlackチャネルIDの配列です。 `channel_scope`が`specific`の場合にのみ適用されます。空の配列を渡すと、リストがクリアされます。

サンプルリクエスト

shell

curl -X PUT https://YOUR_DATA_CENTER/api/agentic/genies/:id \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "name": ":genie_name",
           "description": ":description",
           "instructions": ":instructions",
           "matrix": :true_or_false,
           "channel_mode": ":channel_mode_setting",
           "channel_scope": ":channel_scope",
           "response_mode": ":response_mode",
           "channel_whitelist": [":channel_id"]
         }'

サンプルレスポンス

json

{
  "id": "gin-ZWSMPR4a-TaG7S9",
  "name": "Customer Support Genie v2",
  "description": "Updated to handle billing inquiries in addition to general support.",
  "folder_id": "7498",
  "project_id": "4567",
  "instructions": "You are a knowledgeable, polite support assistant. Always prioritize clear, concise answers.",
  "ai_provider": "open_ai",
  "shared_account_id": 1234,
  "custom_oauth_key_id": 5678,
  "matrix": false,
  "channel_mode": "everywhere",
  "channel_scope": "specific",
  "response_mode": "on_mention",
  "channel_whitelist": ["C0A9H9EN7J6"]
}

IDでGenieを取得

指定したIDに関連付けられているGenieを返します。

GET https://YOUR_DATA_CENTER/api/agentic/genies/:id

クエリパラメータ

名前	タイプ	説明
id	string 必須	取得するGenieのID。

サンプルリクエスト

shell

curl -X GET https://YOUR_DATA_CENTER/api/agentic/genies/:id \
     -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

チャネル構成フィールドは常に返され、明示的な構成が設定されていない場合はデフォルト値が使用されます。

json

{
  "id": "gin-ZWSMPR4a-TaG7S9",
  "name": "Customer Support Genie v2",
  "description": "Updated to handle billing inquiries in addition to general support.",
  "state": "stopped",
  "folder_id": 21285720,
  "project_id": 93761783,
  "instructions": "You are a knowledgeable, polite support assistant. Always prioritize clear, concise answers.",
  "ai_provider": "open_ai",
  "chat_interface": "slack",
  "channel_mode": "dms_only",
  "channel_scope": "specific",
  "response_mode": "on_mention",
  "channel_whitelist": [],
  "skills_count": 5,
  "knowledge_bases_count": 3,
  "user_groups_count": 0,
  "active_recipes_count": 0,
  "inactive_skills_count": 5,
  "custom_oauth_key_id": 5678,
  "connection_id": null,
  "folders": [
      {
          "id": 21285720,
          "name": "Customer Assistants"
      }
  ],
  "logo_url": "https://example.com/logo.png",
  "user_groups": [],
  "created_at": "2026-02-24T08:54:34.170-08:00",
  "updated_at": "2026-02-25T09:34:14.300-08:00"
}

Genieを削除

Genieを削除します。

DELETE https://YOUR_DATA_CENTER/api/agentic/genies/:id

クエリパラメータ

名前	タイプ	説明
id	string 必須	削除するGenieのID。

サンプルリクエスト

shell

curl -X DELETE https://YOUR_DATA_CENTER/api/agentic/genies/:id \
     -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

json

{
    "success": "true"
}

Genieを開始

指定したIDに関連付けられているGenieを開始します。

POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/start

クエリパラメータ

名前	タイプ	説明
id	string 必須	開始するGenieのID。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/start \
     -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

json

{
  "success": true
}

Genieを停止

指定したIDに関連付けられているGenieを停止します。

POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/stop

クエリパラメータ

名前	タイプ	説明
id	string 必須	停止するGenieのID。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/stop \
     -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

json

{
  "success": true
}

Genieにスキルを割り当て

指定したIDに関連付けられているGenieにスキルを割り当てます。

POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/assign_skills

クエリパラメータ

名前	タイプ	説明
id	string 必須	スキルを割り当てるGenieのID。

ペイロード

名前	タイプ	説明
skill_ids	stringの配列必須	Genieに割り当てるスキルIDの配列。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/assign_skills \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "skill_ids": [":skill_id", ":skill_id", ":skill_id"]
         }'

サンプルレスポンス

json

{
    "skills": [
    {
      "id": "65001201",
      "name": "Sales Lead"
    },
    {
      "id": "65704499",
      "name": "Ticket Escalation"
    },
    {
      "id": "65039789",
      "name": "Order Tracking"
    }
  ],
}

Genieからスキルを削除

指定したIDに関連付けられているGenieからスキルを削除します。

POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/remove_skills

クエリパラメータ

名前	タイプ	説明
id	string 必須	スキルを削除するGenieのID。

ペイロード

名前	タイプ	説明
skill_ids	stringの配列必須	Genieから削除するスキルIDの配列。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/remove_skills \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "skill_ids": [":skill_id", ":skill_id"]
         }'

サンプルレスポンス

json

{
    "skills": [
    {
      "id": "65001201",
      "name": "Sales Lead"
    },
    {
      "id": "65704499",
      "name": "Ticket Escalation"
    }
  ],
}

Genieにナレッジベースを割り当て

指定したIDに関連付けられているGenieにナレッジベースを割り当てます。

POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/assign_knowledge_bases

クエリパラメータ

名前	タイプ	説明
id	string 必須	ナレッジベースを割り当てるGenieのID。

ペイロード

名前	タイプ	説明
knowledge_base_ids	stringの配列必須	Genieに割り当てるナレッジベースIDの配列。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/assign_knowledge_bases \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "knowledge_base_ids": [":knowledge_base_id", ":knowledge_base_id"]
         }'

サンプルレスポンス

json

{
    "knowledge_bases": [
    {
      "id": "kb-WSm8kore-blMxrh",
      "name": "Sync Jira"
    },
    {
      "id": "kb-ATx0crok-saMvba",
      "name": "PRD sync"
    }
  ],
}

Genieからナレッジベースを削除

指定したIDに関連付けられているGenieからナレッジベースを削除します。

POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/remove_knowledge_bases

クエリパラメータ

名前	タイプ	説明
id	string 必須	ナレッジベースを削除するGenieのID。

ペイロード

名前	タイプ	説明
knowledge_base_ids	stringの配列必須	Genieから削除するナレッジベースIDの配列。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/remove_knowledge_bases \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "knowledge_base_ids": [":knowledge_base_id"]
         }'

サンプルレスポンス

json

{
    "knowledge_bases": [
    {
      "id": "kb-WSm8kore-blMxrh",
      "name": "Sync Jira"
    }
  ],
}

Genieにユーザーグループを割り当て

指定したIDに関連付けられているGenieにユーザーグループアクセスを割り当てます。

POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/assign_user_groups

クエリパラメータ

名前	タイプ	説明
id	string 必須	ユーザーグループアクセスを割り当てるGenieのID。

ペイロード

名前	タイプ	説明
user_group_ids	stringの配列必須	Genieに追加するユーザーグループIDの配列。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/assign_user_groups \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "user_group_ids": [":user_group_id", ":user_group_id"]
         }'

サンプルレスポンス

json

{
    "user_groups": [
    {
      "id": "ertXU2Z3sQaL47T8PssX2V",
      "name": "Sales"
    },
    {
      "id": "gpzHU1Y3mJaG77W1JbbZ2B",
      "name": "Finance"
    },
  ],
}

Genieからユーザーグループを削除

指定したIDに関連付けられているGenieからユーザーグループアクセスを削除します。

POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/remove_user_groups

クエリパラメータ

名前	タイプ	説明
id	string 必須	ユーザーグループアクセスを削除するGenieのID。

ペイロード

名前	タイプ	説明
user_group_ids	stringの配列必須	Genieから削除するユーザーグループIDの配列。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/remove_user_groups \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "user_group_ids": [":user_group_id"]
         }'

サンプルレスポンス

json

{
    "user_groups": [
    {
      "id": "ertXU2Z3sQaL47T8PssX2V",
      "name": "Sales"
    }
  ],
}

Genieクライアント

Genieクライアントは、アプリケーションがHeadless API経由でGenieを呼び出すために使用するランタイム認証情報を使用します。クライアントを作成し、Genieにアタッチする必要があります。クライアントは実行時にAPIキーまたはOAuth 2.0（PKCE）で認証します。

Genieごとに1つのクライアント

Genieは、アタッチされたクライアントを1つサポートします。クライアントとGenieの関係は1:1です。すでにクライアントがあるGenieにクライアントをアタッチする場合、または別のGenieにすでにアタッチされているクライアントをアタッチする場合は、409 conflictが返されます。クライアントの向き先を変更するには、まず既存のペアリングをデタッチします。

Genieクライアントのリスト

ワークスペース内のGenieクライアントを返します。

GET https://YOUR_DATA_CENTER/api/agentic/genies/clients

サンプルリクエスト

shell

curl -X GET https://YOUR_DATA_CENTER/api/agentic/genies/clients \
     -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

json

{
  "data": [
    { "client_id": "gincl-AaBGpLGx-HLdsJL", "client_name": "HR Concierge Web" }
  ],
  "total": 1,
  "page": 1,
  "per_page": 10
}

Genieクライアントの作成

Genieクライアントを作成します。サーバー間認証情報にはauth.typeをapi_keyに設定し、ブラウザーベースのOAuth 2.0（PKCE）クライアントにはoauthを設定します。

POST https://YOUR_DATA_CENTER/api/agentic/genies/clients

ペイロード

名前	タイプ	説明
client_name	string 必須	クライアントの名前。
auth	オブジェクト必須	認証設定。
auth.type	string 必須	認証タイプ。使用できる値は`api_key`および`oauth`です。
auth.oauth_redirect_url	string 任意	OAuthフロー用に登録されたリダイレクトURL。 `auth.type`が`oauth`の場合は必須です。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies/clients \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{ "client_name": ":client_name", "auth": { "type": ":auth_type" } }'

サンプルレスポンス

APIキーのクライアントは、作成時に1回だけ返される64文字の16進文字列を持つapi_keyを使用します。すべてのクライアントは公開oauth_client_idも返します。 OAuthクライアントはシークレットを返しません。

json

{
  "data": {
    "client_id": "gincl-AaBGpLGx-HLdsJL",
    "client_name": "HR Concierge Web",
    "oauth_client_id": "MtaJ4c5oIc3_c0TASWnCW0rfmCr6R4UTO7",
    "api_key": "<64-character hex string>"
  }
}

Genieクライアントの更新

Genieクライアントの名前を更新します。

PUT https://YOUR_DATA_CENTER/api/agentic/genies/clients/:client_id

ペイロード

名前	タイプ	説明
client_name	string 必須	クライアントの新しい名前。

サンプルリクエスト

shell

curl -X PUT https://YOUR_DATA_CENTER/api/agentic/genies/clients/:client_id \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{ "client_name": ":client_name" }'

Genieクライアントの削除

Genieクライアントを削除し、その認証情報を無効にします。 Genieクライアントを削除せずにGenieから取り外すには、Genieクライアントをデタッチします。

DELETE https://YOUR_DATA_CENTER/api/agentic/genies/clients/:client_id

サンプルリクエスト

shell

curl -X DELETE https://YOUR_DATA_CENTER/api/agentic/genies/clients/:client_id \
     -H 'Authorization: Bearer <api_token>'

Genieクライアントキーの再生成

APIキーのクライアントのAPIキーを再生成します。以前のキーは直ちに無効になり、新しいキーは1回だけ返されます。

POST https://YOUR_DATA_CENTER/api/agentic/genies/clients/:client_id/regenerate

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies/clients/:client_id/regenerate \
     -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

json

{
  "data": {
    "api_key": "<64-character hex string>",
    "updated_at": "2026-06-15T06:44:40-07:00"
  }
}

クライアントのGenieへのアタッチ

指定したGenieにクライアントをアタッチします。 Genieに既存のクライアントがあってはなりません。クライアントは一度に1つのGenieにのみアタッチできます。

POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/clients

ペイロード

名前	タイプ	説明
genie_client_id	string 必須	アタッチするクライアントのID。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/genies/:id/clients \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{ "genie_client_id": ":genie_client_id" }'

クライアントのGenieからのデタッチ

指定したGenieからクライアントをデタッチします。クライアントは削除されず、別のGenieにアタッチできます。

DELETE https://YOUR_DATA_CENTER/api/agentic/genies/:id/clients/:client_id

サンプルリクエスト

shell

curl -X DELETE https://YOUR_DATA_CENTER/api/agentic/genies/:id/clients/:client_id \
     -H 'Authorization: Bearer <api_token>'

会話

会話エンドポイントは、サポートチケットへのトランスクリプトの添付、アドホック調査、レシピベースの自動化など、リアルタイムストリーミングを必要としないユースケース向けにGenieの会話データを公開します。リアルタイムストリーミングが必要なケースでは、監査ログストリーミングを使用します。

ENVIRONMENTスコープのエンドポイント

すべての会話エンドポイントは、使用されたAPIクライアントのEnvironmentにスコープ設定されたデータを返します。レスポンス内のenvironment_typeフィールドとenvironment_idフィールドは、データが属するEnvironmentを識別します。 Environment全体で会話データを取得するには、個別のAPIクライアントを作成して結果を結合します。

会話の一覧表示

Genieが行った会話のリストを返します。最近アクティブだった会話が最初に返されます。

GET /api/agentic/genies/:genie_id/conversations

Path parameters

名前	タイプ	説明
genie_id	string 必須	The ID of the genie whose conversations to retrieve.

クエリパラメータ

名前	タイプ	説明
page[after]	string 任意	The starting point for the next set of results based on the last result of the current page.
page[size]	integer 任意	The number of items to retrieve per page. The default value is `50` and maximum value is `100`.
from	string 任意	The lower bound on `created_at`, in ISO 8601 format (`YYYY-MM-DDTHH:mm:ss.SSSZ`). Defaults to the start of the retention window.
to	string 任意	The upper bound on `created_at`, in ISO 8601 format (`YYYY-MM-DDTHH:mm:ss.SSSZ`). Defaults to the current time.
app_type	string 任意	The trigger source to filter results by. Accepted values are `slack`, `teams`, `go`, `headless_api`, `test_mode`, `genie_task`, or `app_event`. Defaults to all sources.
identity_user_id	string 任意	The ID of a Workato Identity user to filter conversations by. Defaults to all users.
feedback[]	array of string optional	The feedback state to filter conversations by. Accepted values are `has_positive`, `has_negative`, `has_comments`, or `no_feedback`. You can pass `has_positive`, `has_negative`, and `has_comments` together with `OR`. `no_feedback` is exclusive and can't be combined with any other `feedback[]` values. Requests that combine it with other values return `400 Invalid request`. Requires the feedback filtering feature flag to be enabled for your workspace.

Sample request

shell

curl -X GET "https://www.workato.com/api/agentic/genies/gin-AaDdXzLX-dAFvWn-B6/conversations" \
     -H 'Authorization: Bearer <api_token>'

Filter by conversations that received positive or negative feedback:

shell

curl -X GET "https://www.workato.com/api/agentic/genies/gin-AaDdXzLX-dAFvWn-B6/conversations?feedback[]=has_positive&feedback[]=has_negative" \
     -H 'Authorization: Bearer <api_token>'

Sample response

json

{
    "data": [
        {
            "id": "conversation-01KSR1JDQMT001AWVTPMTRJ3K8",
            "topic": "IT support request classification",
            "created_at": 1779997161292,
            "last_message_at": 1779997161292,
            "started_by": {
                "user_id": "5XwAGRPmbmjAwRgRrt7X2D"
            },
            "started_via": "Recipe",
            "app_type": "genie_task",
            "chat_type": "GENIE",
            "genie_version": 0,
            "test_conversation": false,
            "conversation_origin": "genie_task",
            "genie_id": "6055",
            "genie_handle": "gin-AaDdXzLX-dAFvWn-B6",
            "genie_name": "IT Support genie",
            "workspace_id": 40291,
            "environment_id": 40291,
            "environment_type": "dev"
        }
    ],
    "next_cursor": null
}

会話の取得

指定したGenieの会話を返します。

GET /api/agentic/genies/:genie_id/conversations/:conversation_id

Path parameters

名前	タイプ	説明
genie_id	string 必須	The ID of the genie to retrieve a conversation from.
conversation_id	string 必須	The ID of the conversation to retrieve.

Sample request

shell

curl -X GET https://www.workato.com/api/agentic/genies/gin-AaDdXzLX-dAFvWn-B6/conversations/conversation-01KSR1JDQMT001AWVTPMTRJ3K8 \
     -H 'Authorization: Bearer <api_token>'

Sample response

The Get conversation endpoint doesn't return the underlying event payload, such as LLM calls, tool executions, and guardrail evaluations. Use List conversation events to retrieve event-level detail.

When the feedback filtering feature flag is enabled for your workspace, totals includes a feedback block with counts of positive and negative reactions and the number of those reactions that carried a comment. Both count and comments are 0 when the conversation has received no feedback.

json

{
    "data": {
        "id": "conversation-01KSR1JDQMT001AWVTPMTRJ3K8",
        "topic": "IT support request classification",
        "created_at": 1779997161292,
        "last_message_at": 1779997176899,
        "started_by": {
            "user_id": "5XwAGRPmbmjAwRgRrt7X2D"
        },
        "started_via": "Recipe",
        "app_type": "genie_task",
        "chat_type": "GENIE",
        "genie_version": 0,
        "totals": {
            "errors": {
                "count": 0
            },
            "skill_calls": {
                "count": 0
            },
            "kb_calls": {
                "count": 1
            },
            "feedback": {
                "positive": {
                    "count": 6,
                    "comments": 2
                },
                "negative": {
                    "count": 2,
                    "comments": 1
                }
            }
        },
        "test_conversation": false,
        "conversation_origin": "genie_task",
        "genie_id": "6055",
        "genie_handle": "gin-AaDdXzLX-dAFvWn-B6",
        "genie_name": "IT Support genie",
        "workspace_id": 40291,
        "environment_id": 40291,
        "environment_type": "dev"
    }
}

List conversation events

1つの会話のすべてのイベントを返します。 Refer to Genie conversation events for information about each event type.

GET /api/agentic/genies/:genie_id/conversations/:conversation_id/events

Path parameters

名前	タイプ	説明
genie_id	string 必須	The ID of the genie to retrieve conversation events from.
conversation_id	string 必須	The ID of the conversation to retrieve conversation events from.

Query parameters

名前	タイプ	説明
page[after]	string 任意	The starting point for the next set of results based on the last result of the current page.
page[size]	integer 任意	The number of items to retrieve per page. The default value is `20` and maximum value is `100`. We recommend smaller values when events carry large LLM payloads.
order	string 任意	Specifies whether to return newest results first (`desc`) or oldest results first (`asc`). Defaults to `asc`.
include_event_types[]	array of string optional	Specifies the event types to filter results by. Defaults to all event types.
genie_run_id	string 任意	The ID of a run to filter results by. Defaults to all runs.

Sample request

shell

curl -X GET "https://www.workato.com/api/agentic/genies/gin-AaDdXzLX-dAFvWn-B6/conversations/conversation-01KSR1JDQMT001AWVTPMTRJ3K8/events?include_event_types[]=structured_output_formatting_completed" \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json'

Sample response

json

{
    "data": [
        {
            "event_id": "191140b7-9735-4b35-acd5-26d91333d391",
            "event_type": "structured_output_formatting_completed",
            "date_time": "2026-05-28T19:39:38.427751Z",
            "workspace_id": 40291,
            "environment_id": 40291,
            "conversation_id": "conversation-01KSR1JDQMT001AWVTPMTRJ3K8",
            "genie_run_id": "1a11ce5f-f04f-44a3-8dd7-818d24fc3ce1",
            "identity_user_id": "5XwAGRPmbmjAwRgRrt7X2D",
            "genie_handle": "gin-AaDdXzLX-dAFvWn-B6",
            "chat_type": "GENIE",
            "request_id": "00-10f680ac3928f4324a8ce8fc602eb58b-d5e7379818cd3c89-01",
            "app_type": "genie_task",
            "data": "{\"message\":\"{\\\"Category\\\": \\\"Hardware / Performance\\\", \\\"Priority\\\": \\\"Medium\\\", \\\"Summary\\\": \\\"The user is experiencing significant performance degradation on their laptop, including a very slow boot time of approximately 5 minutes, possibly caused by several common endpoint issues.\\\"}\",\"error_message\":null}"
        }
    ],
    "next_cursor": null
}

Guardrails

ガードレールを使用すると、コンテンツ安全性ポリシーをGenieにアタッチできます。ガードレールが存在する場合、モデルが応答する前に、各チャットターンがそのポリシーに照らして評価されます。各ガードレールには、最初にアタッチされたときに2つのデフォルトポリシーがあります: prompt_attackとharmful_content。

ベータ機能

Guardrails APIエンドポイントはベータ版です。詳細については、カスタマーマネージャーにお問い合わせください。

ポリシーの無効化または削除

APIを使用してガードレールからポリシーを削除するためのDELETEガードレールエンドポイントはありません。ポリシーの作成または更新エンドポイントでガードレールを再構成する必要があります。次の表で、タイプに基づいてポリシーをオフにする方法を確認してください。

ポリシー種別	ポリシーをオフにする方法
`pii_detection`, `profanity_filter`	`enabled: false`を設定します。ポリシーはアタッチされたままですが、アクションは実行されません。
`harmful_content`	各カテゴリのフィルターを`strength: "NONE"`に設定して無効にします。 `filters`は空でない状態を維持する必要があります（空の配列は`422`を返します）。そのため、完全に無効化されたポリシーでは5つすべてのエントリが`strength: "NONE"`のままになります。 `enabled`を送信すると`422`が返されます。
`prompt_attack`	`strength: "NONE"`を設定します。 `enabled`を送信すると`422`が返されます。
`custom_word_filter`	リストをクリアするには`custom_words: []`を送信します。
`topic_boundary`	`topics`は空でない必要があります。配列を空にするのではなく、トピックを再構成します。

NONEは有効なstrength値であり、GenieビルダーUIでprompt_attackとharmful_contentをオフにするために使用されます。 2つのデフォルトポリシーであるprompt_attackとharmful_contentは、ガードレールがアタッチされると常に存在します。これらのポリシーはstrength: "NONE"でオフにできますが、ポリシーを削除することはできません。

Genieガードレールの取得

指定したIDに関連付けられているGenieのガードレールとそのポリシーを返します。

GET https://YOUR_DATA_CENTER/api/agentic/genies/:genie_id/guardrails

クエリパラメータ

名前	タイプ	説明
genie_id	string 必須	取得するガードレールが属するGenieのID。 Genieハンドルは`gin-`で始まります。例: `gin-aBC123-xYz789-prod1`。

サンプルリクエスト

shell

curl -sS https://YOUR_DATA_CENTER/api/agentic/genies/:id/guardrails \
  -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

json

{
  "data": {
    "id": "aigrl-aBC123-xYz789-prod1",
    "policies": [
      {
        "id": "aigrlp-aBC123-pQr456-prod1",
        "policy_type": "harmful_content",
        "configuration": {
          "filters": [
            { "type": "HATE",        "strength": "LOW" },
            { "type": "INSULTS",     "strength": "LOW" },
            { "type": "SEXUAL",      "strength": "LOW" },
            { "type": "VIOLENCE",    "strength": "LOW" },
            { "type": "MISCONDUCT",  "strength": "LOW" }
          ]
        }
      },
      {
        "id": "aigrlp-aBC123-sTu789-prod1",
        "policy_type": "prompt_attack",
        "configuration": { "strength": "LOW" }
      }
    ]
  }
}

サンプルレスポンス

json

{ "data": { "id": null, "policies": [] } }

エラーレスポンス

Status	条件
`401 Unauthorized`	APIトークンが欠落しているか無効です。
`404 Not Found`	Genieハンドルが不明である、フォルダスコープ外である、または`genie_guardrails_enabled`フラグがオフです。

ポリシーの作成または更新

指定したIDに関連付けられているGenieで、単一のガードレールポリシーを作成または更新します。指定したpolicy_typeのポリシーが存在しない場合、新しいポリシーが作成されます。それ以外の場合、既存のポリシーの設定が完全に置き換えられます。使用する予定の完全な設定を送信する必要があります。部分更新はサポートされていません。

PUT https://YOUR_DATA_CENTER/api/agentic/genies/:id/guardrails/policies/:policy_type

クエリパラメータ

名前	タイプ	説明
genie_id	string 必須	作成または更新するポリシーが属するGenieのID。
policy_type	string 必須	作成または更新するポリシーのタイプ。使用可能な値: `harmful_content`、`prompt_attack`、`pii_detection`、`topic_boundary`、`profanity_filter`、`custom_word_filter`。

ペイロード

名前	タイプ	説明
configuration	オブジェクト必須	ポリシーの設定。形式は`policy_type`によって異なります。詳細については、ポリシータイプを参照してください。

サンプルリクエスト

shell

curl -X PUT https://YOUR_DATA_CENTER/api/agentic/genies/:id/guardrails/policies/:policy_type \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "configuration": {
             "filters": [
               { "type": ":policy_type","strength": ":strength-level" },
               { "type": ":policy_type","strength": ":strength-level" },
               { "type": ":policy_type","strength": ":strength-level" },
               { "type": ":policy_type","strength": ":strength-level" },
               { "type": ":policy_type","strength": ":strength-level" }
             ]
           }
         }'

サンプルレスポンス

json

{
  "data": {
    "id": "aigrlp-aBC123-pQr456-prod1",
    "policy_type": "harmful_content",
    "configuration": {
      "filters": [
        { "type": "HATE",       "strength": "HIGH" },
        { "type": "INSULTS",    "strength": "HIGH" },
        { "type": "SEXUAL",     "strength": "HIGH" },
        { "type": "VIOLENCE",   "strength": "MEDIUM" },
        { "type": "MISCONDUCT", "strength": "MEDIUM" }
      ]
    }
  }
}

エラーレスポンス

Status	条件
`400 Bad Request`	`policy_type`が6つの有効な値のいずれでもありません。
`401 Unauthorized`	APIトークンが欠落しているか無効です。
`404 Not Found`	Genieが見つからない、Genieにガードレールがアタッチされていない、または機能フラグがオフです。
`422 Unprocessable Entity`	`configuration`の検証に失敗しました。これは、必須フィールドの欠落、不明なキー、無効な列挙値、またはリクエストが制限を超えたことが原因で発生する場合があります。

サンプル422レスポンス

json

{
  "errors": [
    {
      "code": 422,
      "title": "Failed to update policy",
      "detail": "Configuration contains unknown keys: junk"
    }
  ]
}

使用可能なPIIエンティティタイプの一覧表示

pii_detectionポリシーのpii_entities[].typeフィールドで使用できるPIIエンティティタイプ文字列のリストを返します。このリストは現在のEnvironmentに固有のものではありません。

GET https://YOUR_DATA_CENTER/api/agentic/genies/guardrails/policies/pii_entities

サンプルリクエスト

shell

curl -sS https://YOUR_DATA_CENTER/api/agentic/genies/guardrails/policies/pii_entities \
     -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

json

{
  "data": [
    "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY",
    "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER",
    "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER",
    "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER",
    "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME",
    "PASSWORD", "PHONE", "PIN", "SWIFT_CODE",
    "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER",
    "URL", "USERNAME",
    "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER",
    "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER",
    "VEHICLE_IDENTIFICATION_NUMBER"
  ]
}

ポリシータイプ

各policy_typeは特定のconfiguration形式を受け入れます。不明なトップレベルキーを送信すると422で失敗します。

harmful_content

有害なコンテンツのカテゴリについて、ユーザー入力とモデル出力をフィルタリングします。

フィールド	タイプ	必須	メモ
`filters`	配列	はい	空でないこと。各要素は`{ "type": <category>, "strength": <strength> }`です。
`filters[].type`	string	はい	`HATE`、`INSULTS`、`SEXUAL`、`VIOLENCE`、`MISCONDUCT`、`PROMPT_ATTACK`のいずれか。
`filters[].strength`	string	はい	`NONE`、`LOW`、`MEDIUM`、`HIGH`のいずれか。カテゴリを無効にするには、`NONE`を使用するか、エントリを省略します。

json

{
  "configuration": {
    "filters": [
      { "type": "HATE",       "strength": "HIGH" },
      { "type": "INSULTS",    "strength": "HIGH" },
      { "type": "SEXUAL",     "strength": "HIGH" },
      { "type": "VIOLENCE",   "strength": "MEDIUM" },
      { "type": "MISCONDUCT", "strength": "MEDIUM" }
    ]
  }
}

prompt_attack

ユーザーのプロンプト内で、システム指示の上書き、脱獄、またはその他の方法でGenieを操作しようとする試みを検出します。

フィールド	タイプ	必須	メモ
`strength`	string	はい	`NONE`、`LOW`、`MEDIUM`、`HIGH`のいずれか。ポリシーをオフにするには`NONE`を使用します。

json

{ "configuration": { "strength": "HIGH" } }

pii_detection

チャットコンテンツ内のPIIを検出し、ブロック、匿名化、またはトークン化します。組み込みエンティティタイプ、カスタム正規表現、またはその両方で照合できます。

フィールド	タイプ	必須	メモ
`enabled`	boolean	はい	機能を有効にします。 `false`に設定されている場合、他のフィールドは受け入れられますが無視されます。
`action`	string	はい	`BLOCK`、`ANONYMIZE`、`TOKENIZE`のいずれか。 `enabled`が`false`の場合でも必須です。
`pii_entities`	配列	条件付き	`enabled`が`true`で、`pii_custom_regexes`が空または存在しない場合は必須（空でないこと）。各要素は`{ "type": <entity> }`です。有効な値を確認するには、使用可能なPIIエンティティタイプの一覧表示を使用します。
`pii_custom_regexes`	配列	条件付き	`enabled`が`true`で、`pii_entities`が空または存在しない場合は必須（空でないこと）。最大10エントリ。各エントリは`{ "name": <label>, "pattern": <regex> }`です。
`pii_custom_regexes[].name`	string	はい	監査ログに表示される空でないラベル。
`pii_custom_regexes[].pattern`	string	はい	有効な正規表現。 500文字未満である必要があります。

json

{
  "configuration": {
    "enabled": true,
    "action": "ANONYMIZE",
    "pii_entities": [
      { "type": "EMAIL" },
      { "type": "PHONE" },
      { "type": "CREDIT_DEBIT_CARD_NUMBER" },
      { "type": "US_SOCIAL_SECURITY_NUMBER" }
    ],
    "pii_custom_regexes": []
  }
}

topic_boundary

会話を特定のトピックに制限します。任意の発話例は、境界線上のケースをモデルが分類するのに役立ちます。

フィールド	タイプ	必須	メモ
`topics`	配列	はい	空でないこと。最大30トピック。
`topics[].name`	string	はい	50文字未満である必要があります。空でないこと。
`topics[].description`	string	いいえ	300文字未満である必要があります。
`topics[].examples`	文字列の配列	いいえ	最大5件の例。各例は300文字未満である必要があります。

json

{
  "configuration": {
    "topics": [
      {
        "name": "Investment advice",
        "description": "Refuse to provide personalized financial or investment advice; suggest the user contact a licensed advisor.",
        "examples": [
          "Should I buy NVDA stock?",
          "How should I allocate my 401(k)?",
          "Is now a good time to invest in crypto?"
        ]
      }
    ]
  }
}

profanity_filter

不適切表現フィルタは有効または無効にできます。

フィールド	タイプ	必須	メモ
`enabled`	boolean	はい	有効にするには`true`、無効にするには`false`。

json

{ "configuration": { "enabled": true } }

custom_word_filter

明示的な単語または短いフレーズのリストに含まれるいずれかを含むメッセージをブロックします。

フィールド	タイプ	必須	メモ
`custom_words`	文字列の配列	はい	最大100エントリ。各エントリは50文字未満である必要があります。リストをクリアするには空の配列を送信します。

json

{
  "configuration": {
    "custom_words": ["Project Atlas", "Operation Falcon", "internal-only"]
  }
}

ナレッジベース

ナレッジベースの一覧表示

ナレッジベースのリストを返します。

GET https://YOUR_DATA_CENTER/api/agentic/knowledge_bases

クエリパラメータ

名前	タイプ	説明
folder_id	string 任意	ナレッジベースが存在するフォルダのID。
project_id	string 任意	ナレッジベースが存在するプロジェクトのID。
query	string 任意	検索クエリ。
page	integer 任意	取得するナレッジベースのページ番号。最小値は`1`です。
per_page	integer 任意	1ページで返すナレッジベースの数。最小値は`1`です。最大値は`50`です。
sort_term	string 任意	結果の並べ替えに使用するフィールドまたは用語。例: `name`または`latest_activity`。

サンプルリクエスト

shell

curl -X GET https://YOUR_DATA_CENTER/api/agentic/knowledge_bases \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "per_page": :per_page_value,
           "page": :page_value,
           "sort_term": ":sort_term"
         }'

サンプルレスポンス

json

[
  {
    "id": "kb-WSm8kore-blMxrh",
    "name": "Support FAQs",
    "description": "Knowledge base with frequently asked customer support questions.",
    "folder_id": "7498",
    "project_id": "4567"
  },
  {
    "id": "kb-BLm8cove-brMxrh",
    "name": "Sales Playbook",
    "description": "Guidelines and resources for the sales team.",
    "folder_id": "7302",
    "project_id": "9876"
  }
]

ナレッジベースを作成する

新しいナレッジベースを作成します。

POST https://YOUR_DATA_CENTER/api/agentic/knowledge_bases

ペイロード

名前	タイプ	説明
name	string 必須	ナレッジベースの名前。
説明	string 必須	ナレッジベースの説明。
folder_id	string 必須	ナレッジベースが存在するフォルダのID。
source_type	string 必須	レシピなど、ナレッジベースのソース。
data_sources	string 必須	ナレッジベースのデータソースを設定します。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/knowledge_bases \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "name": ":name",
           "description": ":description",
           "folder_id": ":folder_id",
           "source_type": ":source_type",
           "data_sources": ":data_sources"
         }'

サンプルレスポンス

json

{
  "id": "kb-BRm8coke-rhMxsa",
  "name": "Support FAQs",
  "description": "Knowledge base with frequently asked customer support questions.",
  "folder_id": "7498",
  "source_type": "recipe",
  "data_sources": "zendesk_articles"

IDでナレッジベースを取得

指定したIDに関連付けられているナレッジベースを返します。

GET https://YOUR_DATA_CENTER/api/agentic/knowledge_bases/:id

クエリパラメータ

名前	タイプ	説明
id	string 必須	取得するナレッジベースのID。

サンプルリクエスト

shell

curl -X GET https://YOUR_DATA_CENTER/api/agentic/knowledge_bases/:id \
     -H 'Authorization: Bearer <api_token>' \

サンプルレスポンス

json

[
  {
    "id": "kb-WSm8kore-blMxrh",
    "name": "Support FAQs",
    "description": "Knowledge base with frequently asked customer support questions.",
    "folder_id": "7498",
    "project_id": "4567"
  }
]

ナレッジベースを更新

既存のナレッジベースを更新します。

PUT https://YOUR_DATA_CENTER/api/agentic/knowledge_bases/:id

クエリパラメータ

名前	タイプ	説明
id	string 必須	更新するナレッジベースのID。
name	string 任意	ナレッジベースの名前。
説明	string 任意	ナレッジベースの説明。
folder_id	string 任意	ナレッジベースが存在するフォルダのID。
data_sources	object 任意	ナレッジベースに設定されているデータソース。

サンプルリクエスト

shell

curl -X PUT https://YOUR_DATA_CENTER/api/agentic/knowledge_bases/:id \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "name": ":name",
           "description": ":description",
           "data_sources": {
             ":data-source-name": :true_or_false,
             ":data-source-name": :true_or_false
           }
         }'

サンプルレスポンス

json

{
  "id": "kb-WSm8kore-blMxrh",
  "name": "Support FAQs v2",
  "description": "Updated to include billing FAQs in addition to support.",
  "folder_id": "7498",
  "source_type": "recipe",
  "data_sources": {
    "zendesk_articles": true,
    "internal_docs": true
  }
}

ナレッジベースを削除

ナレッジベースを削除します。

DELETE https://YOUR_DATA_CENTER/api/agentic/knowledge_bases/:id

クエリパラメータ

名前	タイプ	説明
id	string 必須	削除するナレッジベースのID。

サンプルリクエスト

shell

curl -X DELETE https://YOUR_DATA_CENTER/api/agentic/knowledge_bases/:id \
     -H 'Authorization: Bearer <api_token>' \

サンプルレスポンス

json

{
    "success": "true"
}

ナレッジベースのデータソースを取得

指定したナレッジベースIDに関連付けられているデータソースを返します。

GET https://YOUR_DATA_CENTER/api/agentic/knowledge_bases/:id/data_sources

クエリパラメータ

名前	タイプ	説明
id	string 必須	データソースを取得するナレッジベースのID。

サンプルリクエスト

shell

curl -X GET https://YOUR_DATA_CENTER/api/agentic/knowledge_bases/:id/data_sources \
     -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

json

{
  "knowledge_base_id": "kb-WSm8kore-blMxrh",
  "data_sources": {
    "zendesk_articles": true,
    "internal_docs": true,
    "slack_channels": false
  }
}

ナレッジベースのレシピを取得

指定したナレッジベースIDに関連付けられているレシピを返します。

GET https://YOUR_DATA_CENTER/api/agentic/knowledge_bases/:id/recipes

クエリパラメータ

名前	タイプ	説明
id	string 必須	関連付けられているレシピを取得するナレッジベースのID。
query	string 任意	検索クエリ。
page	integer 任意	取得するGenieのページ番号。最小値は`1`です。
per_page	integer 任意	1ページで返すGenieの数。最小値は`1`です。最大値は`50`です。
sort_term	string 任意	結果の並べ替えに使用するフィールドまたは用語。例: `name`または`latest_activity`。

サンプルリクエスト

shell

curl -X GET https://YOUR_DATA_CENTER/api/agentic/knowledge_bases/:id/recipes \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "per_page": :per_page_value,
           "page": :page_value,
           "sort_term": ":sort_term"
         }'

サンプルレスポンス

json

[
  {
    "id": 45246391,
    "name": "Customer Support Escalation",
    "description": "Routes high-priority Zendesk tickets to Slack.",
    "knowledge_base_id": "kb-WSm8kore-blMxr/recipes"
  },
  {
    "id": 87654321,
    "name": "Billing Notifications",
    "description": "Sends alerts for overdue invoices to the finance team.",
    "knowledge_base_id": "kb-WSm8kore-blMxr/recipes"
  }
]

スキル

以下のエンドポイントを使用して、プログラムでスキルを操作します:

スキルの一覧表示

スキルのリストを返します。

GET https://YOUR_DATA_CENTER/api/agentic/skills

クエリパラメータ

名前	タイプ	説明
folder_id	string 任意	Genieが存在するフォルダのID。
project_id	string 任意	Genieが存在するプロジェクトのID。
query	string 任意	検索クエリ。
page	integer 任意	取得するGenieのページ番号。最小値は`1`です。
per_page	integer 任意	1ページで返すGenieの数。最小値は`1`です。最大値は`50`です。
sort_term	string 任意	結果の並べ替えに使用するフィールドまたは用語。例: `name`または`latest_activity`。

サンプルリクエスト

shell

curl -X GET https://YOUR_DATA_CENTER/api/agentic/skills \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "per_page": :per_page_value,
           "page": :page_value,
           "sort_term": ":sort_term"
         }'

サンプルレスポンス

json

[
  {
    "id": 65001201,
    "name": "Zendesk Ticket Management",
    "description": "Skill for handling customer support tickets from Zendesk.",
    "folder_id": "7498",
    "project_id": "4567"
  },
  {
    "id": 65039789,
    "name": "Slack Notifications",
    "description": "Skill for sending targeted Slack alerts.",
    "folder_id": "7302",
    "project_id": "4567"
  }
]

既存のレシピからスキルを作成

既存のレシピをスキルに変換します。レシピでは、定義済みの入力とアクションを含むStart workflowトリガーを使用する必要があります。このエンドポイントをrecipe_idで呼び出して、レシピをAgent Studioのスキルとして登録します。

POST https://YOUR_DATA_CENTER/api/agentic/skills

ペイロード

名前	タイプ	説明
recipe_id	integer 必須	スキルに変換するレシピのID。

サンプルリクエスト

shell

curl -X POST https://YOUR_DATA_CENTER/api/agentic/skills \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "recipe_id": :recipe_id
         }'

サンプルレスポンス

json

{
  "name": "Customer Escalation Skill",
  "description": "Skill automatically routes high-priority Zendesk tickets to Slack.",
  "recipe_id": 65039789,
  "folder_id": "7498",
  "project_id": "4567"
}

IDでスキルを取得

指定したIDに関連付けられているスキルを返します。

GET https://YOUR_DATA_CENTER/api/agentic/skills/:id

クエリパラメータ

名前	タイプ	説明
id	string 必須	取得するスキルのID。

サンプルリクエスト

shell

curl -X GET https://YOUR_DATA_CENTER/api/agentic/skills/:id \
     -H 'Authorization: Bearer <api_token>' \

サンプルレスポンス

json

{
  "name": "Customer Escalation Skill",
  "description": "Skill automatically routes high-priority Zendesk tickets to Slack.",
  "recipe_id": 65039789,
  "folder_id": "7498",
  "project_id": "4567"
}

最終更新日:

Agent Studio ​

レート制限 ​

クイックリファレンス ​

Genie ​

Genieの一覧表示 ​

クエリパラメーター ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieを作成する ​

ペイロード ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieを更新 ​

クエリパラメータ ​

サンプルリクエスト ​

サンプルレスポンス ​

IDでGenieを取得 ​

クエリパラメータ ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieを削除 ​

クエリパラメータ ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieを開始 ​

クエリパラメータ ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieを停止 ​

クエリパラメータ ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieにスキルを割り当て ​

クエリパラメータ ​

ペイロード ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieからスキルを削除 ​

クエリパラメータ ​

ペイロード ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieにナレッジベースを割り当て ​

クエリパラメータ ​

ペイロード ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieからナレッジベースを削除 ​

クエリパラメータ ​

ペイロード ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieにユーザーグループを割り当て ​

クエリパラメータ ​

ペイロード ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieからユーザーグループを削除 ​

クエリパラメータ ​

ペイロード ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieクライアント ​

Genieクライアントのリスト ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieクライアントの作成 ​

ペイロード ​

サンプルリクエスト ​

サンプルレスポンス ​

Genieクライアントの更新 ​

ペイロード ​

サンプルリクエスト ​

Genieクライアントの削除 ​

サンプルリクエスト ​

Genieクライアントキーの再生成 ​

サンプルリクエスト ​

サンプルレスポンス ​

クライアントのGenieへのアタッチ ​

ペイロード ​

Agent Studio

レート制限

クイックリファレンス

Genie

Genieの一覧表示

クエリパラメーター

サンプルリクエスト

サンプルレスポンス

Genieを作成する

ペイロード

サンプルリクエスト

サンプルレスポンス

Genieを更新

クエリパラメータ

サンプルリクエスト

サンプルレスポンス

IDでGenieを取得

クエリパラメータ

サンプルリクエスト

サンプルレスポンス

Genieを削除

クエリパラメータ

サンプルリクエスト

サンプルレスポンス

Genieを開始

クエリパラメータ

サンプルリクエスト

サンプルレスポンス

Genieを停止

クエリパラメータ

サンプルリクエスト

サンプルレスポンス

Genieにスキルを割り当て

クエリパラメータ

ペイロード

サンプルリクエスト

サンプルレスポンス

Genieからスキルを削除

クエリパラメータ

ペイロード

サンプルリクエスト

サンプルレスポンス

Genieにナレッジベースを割り当て

クエリパラメータ

ペイロード

サンプルリクエスト

サンプルレスポンス

Genieからナレッジベースを削除

クエリパラメータ

ペイロード

サンプルリクエスト

サンプルレスポンス

Genieにユーザーグループを割り当て

クエリパラメータ

ペイロード

サンプルリクエスト

サンプルレスポンス

Genieからユーザーグループを削除

クエリパラメータ

ペイロード

サンプルリクエスト

サンプルレスポンス

Genieクライアント

Genieクライアントのリスト

サンプルリクエスト

サンプルレスポンス

Genieクライアントの作成

ペイロード

サンプルリクエスト

サンプルレスポンス

Genieクライアントの更新

ペイロード

サンプルリクエスト

Genieクライアントの削除

サンプルリクエスト

Genieクライアントキーの再生成

サンプルリクエスト

サンプルレスポンス

クライアントのGenieへのアタッチ

ペイロード