Agents
Agent related APIs
認証用のAPIキー
0100任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
正常に取得しました。
GET /webapi/v2/agents HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
正常に取得しました。
{
"agents": [
{
"id": "text",
"lastName": "text",
"firstName": "text",
"email": "text"
}
]
}認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
GET /webapi/v2/agents/{agent_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
OK
{
"id": "text",
"lastName": "text",
"firstName": "text",
"email": "text"
}認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
成功
GET /webapi/agent_builder/single_action_app_tools HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
成功
{
"tools": [
{
"id": "text",
"name": "text",
"display_name": "text",
"description": "text",
"single_action_inputs": [
{
"name": "text",
"type": "text",
"description": "text"
}
]
}
]
}認証用のAPIキー
取得するツールの名前。
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
シングルアクションアプリツールの取得に成功しました。
ツールが見つかりませんでした。
GET /webapi/agent_builder/single_action_app_tool/{tool_name} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"success": true,
"tool": {
"id": "text",
"name": "text",
"display_name": "text",
"description": "text",
"single_action_inputs": [
{
"name": "text",
"type": "text",
"description": "text"
}
]
}
}認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
エージェントツールを正常に取得しました
GET /webapi/agent_builder/agent_tools HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
エージェントツールを正常に取得しました
{
"tools": [
{
"id": "text",
"name": "text",
"display_name": "text",
"description": "text",
"project_id": "text",
"published": true,
"variables": [
{
"name": "text",
"type": "text",
"description": "text",
"required": true
}
]
}
]
}認証用のAPIキー
取得するエージェントツールの名前
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
エージェントツールを正常に取得しました
エージェントツールが見つかりません。
GET /webapi/agent_builder/agent_tool/{tool_name} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"success": true,
"tool": {}
}OAuth状態パラメータを使用してAIエージェントのOAuth2構成情報を取得します。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OAuth構成を識別するためのOAuth2状態パラメータ。
OAuth2 情報を正常に取得しました。
Bad request - 無効なインプットです。
OAuth2 information が見つかりません。
POST /webapi/agent_builder/oauth2_information HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"state": "text"
}{
"success": true,
"oauth2_info": {
"id": "text",
"hub_id": "text",
"configuration_name": "text",
"authorization_url": "text",
"token_url": "text",
"client_id": "text",
"client_secret": "text",
"scope": [
"text"
],
"redirect_uri": "text",
"place_access_token": "text",
"place_expires_in": "text",
"place_refresh_token": "text",
"place_token_type": "text",
"headers": {},
"additional": {},
"token_info": {},
"token_generated": 1,
"state": "text",
"code_verifier": "text"
}
}Update OAuth2 token information (tokenInfo and tokenGenerated) for an existing OAuth configuration
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OAuth2 state parameter to identify the OAuth configuration
Updated token information
Timestamp when the token was generated
Successfully updated OAuth2 information
Bad request - invalid input
OAuth2 information not found
POST /webapi/agent_builder/oauth2_information/update HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 50
{
"state": "text",
"tokenInfo": {},
"tokenGenerated": 1
}{
"success": true
}プロジェクトからメンバーを作成および削除するために使用されます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
作成または削除したいメンバーのメールアドレス。
メンバーを削除したい場合はTrue、作成したい場合はFalseを指定します。
新しいメンバーを作成する際に必要です。パスワードは次の4種類のうち3種類の文字列を含む必要があります。(小文字、大文字、数字、非英数字)
作成中のメンバーアカウントの言語設定です。二文字のISO 639-1コードを使用してください。(例:”JA”)
メンバーに割り当てるメンバーグループのIDです。
メンバーに割り当てるメンバーグループの名前です。
メンバーが正常に編集されました。
無効なパラメータ
メンバーが見つかりませんでした。
POST /webapi/agent_management HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128
{
"email": "text",
"deleteFlag": true,
"password": "text",
"locale": "text",
"permission_group_id": "text",
"permission_group_name": "text"
}{
"result": {
"id": "text",
"status": "text"
}
}Last updated
Was this helpful?