Agents
Agent related APIs
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
GET /webapi/v2/agents HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
OK
{
"agents": [
{
"id": "text",
"lastName": "text",
"firstName": "text",
"email": "text"
}
]
}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
GET /webapi/agent_builder/single_action_app_tools HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
Successfully retrieved single action app tools
{
"tools": [
{
"id": "text",
"name": "text",
"display_name": "text",
"description": "text",
"single_action_inputs": [
{
"name": "text",
"type": "text",
"description": "text"
}
]
}
]
}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
Tool not found
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"
}
]
}
}Used to create and delete agents from the project
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
Agent not found
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"
}
}Was this helpful?