User Management

Agent related APIs

에이전트 얻기

get

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

/webapi/v2/agents

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

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Query parameters

offsetintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

emailstring · nullableOptional

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

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.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

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

Get Agent

get

https://backend.alli.aihttps://backend-ja.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

Your API key for authentication

Path parameters

agent_idstringRequired

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

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.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

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

대량 유저 작업 수행

post

https://backend.alli.aihttps://backend-ja.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

Your API key for authentication

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

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.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.alli.aihttps://backend-ja.alli.ai

/webapi/v2/user/{own_user_id}

Retrieve a user by their own_user_id, including email and customer group information.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

own_user_idstringRequired

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

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.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

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

Bulk Invite Members

post

https://backend.alli.aihttps://backend-ja.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

Your API key for authentication

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

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.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 Permissions

post

https://backend.alli.aihttps://backend-ja.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

Your API key for authentication

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

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.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.alli.aihttps://backend-ja.alli.ai

/webapi/v2/members/bulk/remove

Bulk remove members from project.

This endpoint removes existing members from the project.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

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

List Permission Groups

get

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

/webapi/v2/permission_groups

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

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Query parameters

search_termstring · nullableOptional

limitintegerOptionalDefault: 100

offsetintegerOptionalDefault: 0

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

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.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.alli.aihttps://backend-ja.alli.ai

/webapi/v2/permission_groups

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

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

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.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.alli.aihttps://backend-ja.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

Your API key for authentication

Path parameters

permission_group_idstringRequired

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

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.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.alli.aihttps://backend-ja.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

Your API key for authentication

Path parameters

permission_group_idstringRequired

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

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.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

No content

List Permission Group Agents

get

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

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

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

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

permission_group_idstringRequired

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

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.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

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

Update Permission Group Name

put

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

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

Rename an existing permission group.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

permission_group_idstringRequired

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

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.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.alli.aihttps://backend-ja.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

Your API key for authentication

Path parameters

permission_group_idstringRequired

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

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.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.alli.aihttps://backend-ja.alli.ai

/webapi/agent_builder/single_action_app_tools

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

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.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.alli.aihttps://backend-ja.alli.ai

/webapi/agent_builder/single_action_app_tool/{tool_name}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

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

Retrieve all agent tools for the project

get

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

/webapi/agent_builder/agent_tools

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

Successfully retrieved agent tools

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

Retrieve a specific agent tool by its name

get

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

/webapi/agent_builder/agent_tool/{tool_name}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

tool_namestringRequired

Name of the agent 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

Successfully retrieved the agent tool

application/json

successbooleanOptional

Indicates if the operation was successful

toolobjectOptional

The agent tool data

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

Agent tool not found

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.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "tool": {}
}

Retrieve OAuth2 information by state

post

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

/webapi/agent_builder/oauth2_information

Get OAuth2 configuration information for an AI agent using the OAuth state parameter

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

application/json

statestringRequired

OAuth2 state parameter to identify the OAuth configuration

Responses

200

Successfully retrieved 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

HTTPcURLJavaScriptPython

POST /webapi/agent_builder/oauth2_information HTTP/1.1
Host: backend.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.alli.aihttps://backend-ja.alli.ai

/webapi/agent_builder/oauth2_information/update

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

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

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.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.alli.aihttps://backend-ja.alli.ai

/webapi/agent_management

프로젝트에서 에이전트를 생성 및 삭제하는 데 사용됨

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

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

application/json

emailstringOptional

생성하거나 삭제하려는 에이전트의 이메일

deleteFlagbooleanOptional

에이전트를 삭제하려면 True, 생성하려면 False

passwordstringOptional

새 에이전트를 만들 때 필요합니다. 비밀번호는 유효해야 합니다 (소문자, 대문자, 숫자, 비알파벳 문자 중 4개 중 3개를 포함해야 함).

localestringOptional

생성 중인 계정의 언어 설정. 두 글자 ISO 639-1 코드를 사용해 주세요.

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