Agents

Agent related APIs

メンバーを取得する

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

offsetintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

emailany ofOptional

stringOptional

or

nullOptional

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

正常に取得しました。

application/json

get

/webapi/v2/agents

HTTPcURLJavaScriptPython

GET /webapi/v2/agents HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

正常に取得しました。

{
  "agents": [
    {
      "id": "text",
      "lastName": "text",
      "firstName": "text",
      "email": "text"
    }
  ]
}

Get Agent Detail

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

agent_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

OK

application/json

get

/webapi/v2/agents/{agent_id}

HTTPcURLJavaScriptPython

GET /webapi/v2/agents/{agent_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

{
  "id": "text",
  "lastName": "text",
  "firstName": "text",
  "email": "text"
}

プロジェクトにある全てのシングルアクションのアプリを取得

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

成功

application/json

get

/webapi/agent_builder/single_action_app_tools

HTTPcURLJavaScriptPython

GET /webapi/agent_builder/single_action_app_tools HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

成功

{
  "tools": [
    {
      "id": "text",
      "name": "text",
      "display_name": "text",
      "description": "text",
      "single_action_inputs": [
        {
          "name": "text",
          "type": "text",
          "description": "text"
        }
      ]
    }
  ]
}

特定のシングルアクションアプリのツールを名前で取得する

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

tool_namestringRequired

取得するツールの名前。

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

シングルアクションアプリツールの取得に成功しました。

application/json

404

ツールが見つかりませんでした。

application/json

get

/webapi/agent_builder/single_action_app_tool/{tool_name}

HTTPcURLJavaScriptPython

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"
      }
    ]
  }
}

プロジェクトのすべてのエージェントツールを取得します

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

エージェントツールを正常に取得しました

application/json

get

/webapi/agent_builder/agent_tools

HTTPcURLJavaScriptPython

GET /webapi/agent_builder/agent_tools HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

エージェントツールを正常に取得しました

{
  "tools": [
    {
      "id": "text",
      "name": "text",
      "display_name": "text",
      "description": "text",
      "project_id": "text",
      "published": true,
      "variables": [
        {
          "name": "text",
          "type": "text",
          "description": "text",
          "required": true
        }
      ]
    }
  ]
}

特定のエージェントツールを名前で取得する

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

tool_namestringRequired

取得するエージェントツールの名前

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

エージェントツールを正常に取得しました

application/json

404

エージェントツールが見つかりません。

get

/webapi/agent_builder/agent_tool/{tool_name}

HTTPcURLJavaScriptPython

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": {}
}

エージェントのOAuth2の校正情報を取得する。

post

OAuth状態パラメータを使用してAIエージェントのOAuth2構成情報を取得します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

statestringRequired

OAuth構成を識別するためのOAuth2状態パラメータ。

Responses

200

OAuth2 情報を正常に取得しました。

application/json

400

Bad request - 無効なインプットです。

application/json

404

OAuth2 information が見つかりません。

application/json

post

/webapi/agent_builder/oauth2_information

HTTPcURLJavaScriptPython

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

post

Update OAuth2 token information (tokenInfo and tokenGenerated) for an existing OAuth configuration

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

statestringRequired

OAuth2 state parameter to identify the OAuth configuration

tokenInfoobjectOptional

Updated token information

tokenGeneratednumberOptional

Timestamp when the token was generated

Responses

200

Successfully updated OAuth2 information

application/json

400

Bad request - invalid input

application/json

404

OAuth2 information not found

application/json

post

/webapi/agent_builder/oauth2_information/update

HTTPcURLJavaScriptPython

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
}

メンバーの管理

post

プロジェクトからメンバーを作成および削除するために使用されます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

emailstringOptional

作成または削除したいメンバーのメールアドレス。

deleteFlagbooleanOptional

メンバーを削除したい場合はTrue、作成したい場合はFalseを指定します。

passwordstringOptional

新しいメンバーを作成する際に必要です。パスワードは次の4種類のうち3種類の文字列を含む必要があります。(小文字、大文字、数字、非英数字)

localestringOptional

作成中のメンバーアカウントの言語設定です。二文字のISO 639-1コードを使用してください。(例:”JA”)

permission_group_idstringOptional

メンバーに割り当てるメンバーグループのIDです。

permission_group_namestringOptional

メンバーに割り当てるメンバーグループの名前です。

Responses

200

メンバーが正常に編集されました。

application/json

400

無効なパラメータ

application/json

404

メンバーが見つかりませんでした。

application/json

post

/webapi/agent_management

HTTPcURLJavaScriptPython

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"
  }
}