Agents

Agent related APIs

メンバーを取得する

get

Authorizations

Query parameters

offsetintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

emailany ofOptional

stringOptional

or

nullOptional

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

正常に取得しました。

application/json

get

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

Authorizations

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

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

200

OK

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

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

get

Authorizations

Path parameters

tool_namestringRequired

Name of the tool to retrieve

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

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

application/json

404

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

application/json

get

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

メンバーの管理

post

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

Authorizations

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

emailstringOptional

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

deleteFlagbooleanOptional

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

passwordstringOptional

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

localestringOptional

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

permission_group_idstringOptional

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

permission_group_namestringOptional

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

Responses

200

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

application/json

400

Invalid Parameter

application/json

404

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

application/json

post

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