User Management

Agent related APIs

メンバーを取得する

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/agents

List agents (users) in the project with optional email filter and pagination.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

offsetintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

emailstring · nullableOptional

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

正常に取得しました。

application/json

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/agents

HTTPcURLJavaScriptPython

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

Get Agent Detail

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/agents/{agent_id}

Retrieve a single agent by ID. Returns 404 if the agent is not a member of the project.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

agent_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

OK

application/json

idstringRequired

lastNamestringRequired

firstNamestringRequired

emailstringRequired

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

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: */*

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

一括ユーザー操作を実行する

post

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/users/bulk

Create, update, or delete users in bulk. Supports up to 100 users per request. Each user result includes individual success/error status.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

actionstring · enumRequiredPossible values:

Responses

200

正常に実行されました。

application/json

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/users/bulk

HTTPcURLJavaScriptPython

POST /webapi/v2/users/bulk HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "action": "create",
  "users": [
    {
      "data": [
        {
          "key": "first_name",
          "value": "John"
        },
        {
          "key": "last_name",
          "value": "Doe"
        },
        {
          "key": "email",
          "value": "[e-mail]"
        },
        {
          "key": "customer_group",
          "value": "HR"
        }
      ],
      "ownUserId": "A12345"
    }
  ]
}

{
  "result": [
    {
      "ownUserId": "A12345",
      "status": "success"
    }
  ]
}

ユーザーを取得

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/user/{own_user_id}

ユーザー情報を取得します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

own_user_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

成功

application/json

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/user/{own_user_id}

HTTPcURLJavaScriptPython

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

{
  "result": {
    "userId": "text",
    "firstName": "text",
    "lastName": "text"
  }
}

Bulk Invite Members

post

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/members/bulk/invite

Bulk invite members to project.

This endpoint:

1. Creates agents for emails that don't exist

2. Adds agents as project members if not already

3. Creates users for works projects

4. Assigns permission groups (creates if needed)

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

Request for bulk inviting members.

Responses

200

OK

application/json

Response for bulk member operations.

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/members/bulk/invite

HTTPcURLJavaScriptPython

POST /webapi/v2/members/bulk/invite HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "members": [
    {
      "email": "[e-mail]",
      "firstName": "John",
      "groups": [
        "Admin",
        "Developer"
      ],
      "lastName": "Doe",
      "locale": "en"
    }
  ]
}

{
  "result": [
    {
      "emails": [
        "[e-mail]",
        "[e-mail]"
      ],
      "errorMessage": null,
      "status": "success"
    },
    {
      "emails": [
        "[e-mail]"
      ],
      "errorMessage": "AGENT_CREATION_FAILED",
      "status": "fail"
    }
  ]
}

Bulk Update Member Permission Groups

post

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/members/bulk/update_permission_groups

Bulk update member permission groups.

This endpoint updates permission groups for existing members only.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

Request for bulk updating member permission groups.

Responses

200

OK

application/json

Response for bulk member operations.

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/members/bulk/update_permission_groups

HTTPcURLJavaScriptPython

POST /webapi/v2/members/bulk/update_permission_groups HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "members": [
    {
      "email": "[e-mail]",
      "groups": [
        "Admin",
        "Developer"
      ]
    }
  ]
}

{
  "result": [
    {
      "emails": [
        "[e-mail]",
        "[e-mail]"
      ],
      "errorMessage": null,
      "status": "success"
    },
    {
      "emails": [
        "[e-mail]"
      ],
      "errorMessage": "AGENT_CREATION_FAILED",
      "status": "fail"
    }
  ]
}

Bulk Remove Members

post

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/members/bulk/remove

Bulk remove members from project.

This endpoint removes existing members from the project.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

Request for bulk removing members.

Responses

200

OK

application/json

Response for bulk member operations.

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/members/bulk/remove

HTTPcURLJavaScriptPython

POST /webapi/v2/members/bulk/remove HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "members": [
    {
      "email": "[e-mail]"
    }
  ]
}

{
  "result": [
    {
      "emails": [
        "[e-mail]",
        "[e-mail]"
      ],
      "errorMessage": null,
      "status": "success"
    },
    {
      "emails": [
        "[e-mail]"
      ],
      "errorMessage": "AGENT_CREATION_FAILED",
      "status": "fail"
    }
  ]
}

Get Permission Groups

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/permission_groups

List permission groups in the project with optional search and pagination.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

search_termstring · nullableOptional

limitintegerOptionalDefault: 100

offsetintegerOptionalDefault: 0

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

OK

application/json

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/permission_groups

HTTPcURLJavaScriptPython

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

{
  "permissionGroups": [
    {
      "id": "text",
      "name": "text",
      "isAdmin": true,
      "isDefault": true,
      "order": 1,
      "permissions": [
        "text"
      ],
      "agentCount": 1
    }
  ]
}

Create Permission Group

post

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/permission_groups

Create a new permission group with the specified name, permissions, and member agents.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

namestringRequired

agentIdsstring[]Optional

Responses

200

OK

application/json

idstringRequired

namestringRequired

isAdminbooleanRequired

isDefaultbooleanRequired

orderinteger · nullableRequired

permissionsstring[]Required

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/permission_groups

HTTPcURLJavaScriptPython

POST /webapi/v2/permission_groups HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "name": "text",
  "agentIds": [
    "text"
  ],
  "permissions": [
    "dashboard_accessible"
  ]
}

{
  "id": "text",
  "name": "text",
  "isAdmin": true,
  "isDefault": true,
  "order": 1,
  "permissions": [
    "text"
  ],
  "agents": [
    {
      "id": "text",
      "lastName": "text",
      "firstName": "text",
      "email": "text"
    }
  ]
}

Get Permission Group

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/permission_groups/{permission_group_id}

Retrieve a single permission group by ID, including its permissions and member agents.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

permission_group_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

OK

application/json

idstringRequired

namestringRequired

isAdminbooleanRequired

isDefaultbooleanRequired

orderinteger · nullableRequired

permissionsstring[]Required

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/permission_groups/{permission_group_id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "isAdmin": true,
  "isDefault": true,
  "order": 1,
  "permissions": [
    "text"
  ],
  "agents": [
    {
      "id": "text",
      "lastName": "text",
      "firstName": "text",
      "email": "text"
    }
  ]
}

Delete Permission Group

delete

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/permission_groups/{permission_group_id}

Delete a permission group. Members of this group will lose the associated permissions.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

permission_group_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

OK

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

delete/webapi/v2/permission_groups/{permission_group_id}

HTTPcURLJavaScriptPython

DELETE /webapi/v2/permission_groups/{permission_group_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

No content

Get Permission Group Agents

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/permission_groups/{permission_group_id}/agents

List all agents (members) assigned to a specific permission group.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

permission_group_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

OK

application/json

idstringRequired

lastNamestringRequired

firstNamestringRequired

emailstringRequired

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/permission_groups/{permission_group_id}/agents

HTTPcURLJavaScriptPython

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

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

Update Permission Group Name

put

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/permission_groups/{permission_group_id}/name

Rename an existing permission group.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

permission_group_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

namestringRequired

Responses

200

OK

application/json

idstringRequired

namestringRequired

isAdminbooleanRequired

isDefaultbooleanRequired

orderinteger · nullableRequired

permissionsstring[]Required

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

put/webapi/v2/permission_groups/{permission_group_id}/name

HTTPcURLJavaScriptPython

PUT /webapi/v2/permission_groups/{permission_group_id}/name HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "text",
  "name": "text",
  "isAdmin": true,
  "isDefault": true,
  "order": 1,
  "permissions": [
    "text"
  ],
  "agents": [
    {
      "id": "text",
      "lastName": "text",
      "firstName": "text",
      "email": "text"
    }
  ]
}

Update Permission Group Permissions

put

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/permission_groups/{permission_group_id}/permissions

Replace the permission set of an existing permission group. Dependent permissions must be included together.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

permission_group_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

Responses

200

OK

application/json

idstringRequired

namestringRequired

isAdminbooleanRequired

isDefaultbooleanRequired

orderinteger · nullableRequired

permissionsstring[]Required

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

put/webapi/v2/permission_groups/{permission_group_id}/permissions

HTTPcURLJavaScriptPython

PUT /webapi/v2/permission_groups/{permission_group_id}/permissions HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "permissions": [
    "dashboard_accessible"
  ]
}

{
  "id": "text",
  "name": "text",
  "isAdmin": true,
  "isDefault": true,
  "order": 1,
  "permissions": [
    "text"
  ],
  "agents": [
    {
      "id": "text",
      "lastName": "text",
      "firstName": "text",
      "email": "text"
    }
  ]
}

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

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/agent_builder/single_action_app_tools

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

成功

application/json

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

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: */*

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

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

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/agent_builder/single_action_app_tool/{tool_name}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

tool_namestringRequired

取得するツールの名前。

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

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

application/json

successbooleanOptional

リクエストが成功したかどうかを示します。

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

404

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

application/json

500

Internal server error.

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

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/agent_builder/agent_tools

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

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

application/json

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

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: */*

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

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/agent_builder/agent_tool/{tool_name}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

tool_namestringRequired

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

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

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

application/json

successbooleanOptional

操作が成功したかどうかを示します。

toolobjectOptional

エージェントツールのデータです。

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

404

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

500

Internal server error.

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

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/agent_builder/oauth2_information

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

successbooleanOptional

操作が成功したかどうかを示します。

400

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

application/json

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

404

OAuth2 information が見つかりません。

application/json

500

Internal server error.

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

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/agent_builder/oauth2_information/update

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

successbooleanOptional

Indicates if the operation was successful

400

Bad request - invalid input

application/json

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

404

OAuth2 information not found

application/json

500

Internal server error.

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

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/agent_management

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

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

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

404

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

application/json

500

Internal server error.

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