User Management
Your API key for authentication
0100Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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"
}
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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"
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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": "john_doe@allganize.io"
},
{
"key": "customer_group",
"value": "HR"
}
],
"ownUserId": "A12345"
}
]
}{
"result": [
{
"ownUserId": "A12345",
"status": "success"
}
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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"
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Request for bulk inviting members.
OK
Response for bulk member operations.
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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": "user@example.com",
"firstName": "John",
"groups": [
"Admin",
"Developer"
],
"lastName": "Doe",
"locale": "en"
}
]
}{
"result": [
{
"emails": [
"user1@example.com",
"user2@example.com"
],
"errorMessage": null,
"status": "success"
},
{
"emails": [
"user3@example.com"
],
"errorMessage": "AGENT_CREATION_FAILED",
"status": "fail"
}
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Request for bulk updating member permission groups.
OK
Response for bulk member operations.
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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": "user@example.com",
"groups": [
"Admin",
"Developer"
]
}
]
}{
"result": [
{
"emails": [
"user1@example.com",
"user2@example.com"
],
"errorMessage": null,
"status": "success"
},
{
"emails": [
"user3@example.com"
],
"errorMessage": "AGENT_CREATION_FAILED",
"status": "fail"
}
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Request for bulk removing members.
OK
Response for bulk member operations.
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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": "user@example.com"
}
]
}{
"result": [
{
"emails": [
"user1@example.com",
"user2@example.com"
],
"errorMessage": null,
"status": "success"
},
{
"emails": [
"user3@example.com"
],
"errorMessage": "AGENT_CREATION_FAILED",
"status": "fail"
}
]
}Your API key for authentication
1000Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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
}
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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"
}
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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"
}
]
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
DELETE /webapi/v2/permission_groups/{permission_group_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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"
}
]Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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
Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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"
}
]
}Retrieve all single action app tools for the project
Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Successfully retrieved single action app tools
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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"
}
]
}
]
}Retrieve a specific single action app tool by its name
Your API key for authentication
Name of the tool to retrieve
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Successfully retrieved the single action app tool
Indicates if the operation was successful
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Tool not found
Internal server error.
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"
}
]
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Successfully retrieved agent tools
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
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
}
]
}
]
}Your API key for authentication
Name of the agent tool to retrieve
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Successfully retrieved the agent tool
Indicates if the operation was successful
The agent tool data
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Agent tool not found
Internal server error.
GET /webapi/agent_builder/agent_tool/{tool_name} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"success": true,
"tool": {}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OAuth2 state parameter to identify the OAuth configuration
Successfully retrieved OAuth2 information
Indicates if the operation was successful
Bad request - invalid input
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
OAuth2 information not found
Internal server error.
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"
}
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
OAuth2 state parameter to identify the OAuth configuration
Updated token information
Timestamp when the token was generated
Successfully updated OAuth2 information
Indicates if the operation was successful
Bad request - invalid input
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
OAuth2 information not found
Internal server error.
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
}Your API key for authentication
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
The email of the agent you want to create or delete
True if you want to delete an agent, False if you want to create
Required when creating a new agent. Password must be valid (contain 3 out 4 following characters - lowercase, uppercase, numeric, non-alphanumeric)
The language setting of the account being created. Use a two-letter ISO 639-1 code
ID of the permission group to assign to the agent
Name of the permission group to assign to the agent
Agent edited successfully
Invalid parameters
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Agent not found
Internal server error.
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"
}
}Last updated