App Market
App related APIs
This API allows you to list apps in the project. Apps are sorted by weight in descending order by default.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Query Parameters
searchTerm (string, optional): Search term for app name or description.
categories (array[string], optional): Filter by app categories.
type (string, optional): Filter by app type.
published (boolean, optional): Filter by published status.
pageSize (integer, optional): Number of apps per page. Defaults to 50.
cursor (string, optional): Cursor for pagination.
Your API key for authentication
Search term for app name or description
Filter by app categories
Filter by app type
Filter by published status
Number of apps per page
50Cursor for pagination
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
Response for listing apps.
Cursor for pagination
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/apps HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"apps": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "text",
"category": "text",
"published": true,
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}
],
"cursor": "text"
}This API allows you to retrieve a specific app by its ID.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
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
App information.
Unique ID of the app
Name of the app
Description of the app
Type of the app
Category of the app
Whether the app is published
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/apps/{app_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"id": "text",
"name": "text",
"description": "text",
"type": "text",
"category": "text",
"published": true,
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}This API allows you to update an app's properties.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
name (string, optional): Name of the app.
description (string, optional): Description of the app.
category (string, optional): Category of the app.
published (boolean, optional): Whether the app is published.
agentPermission (object, optional): Agent permission settings.
userPermission (object, optional): User permission settings.
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 schema for updating an app.
Name of the app
Description of the app
Category of the app
Whether the app is published
OK
App information.
Unique ID of the app
Name of the app
Description of the app
Type of the app
Category of the app
Whether the app is published
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.
PATCH /webapi/v2/apps/{app_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 359
{
"name": "text",
"description": "text",
"category": "text",
"published": true,
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}{
"id": "text",
"name": "text",
"description": "text",
"type": "text",
"category": "text",
"published": true,
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}This API allows you to run a campaign app with streaming response.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body (multipart/form-data)
conversationId (string, optional): Existing conversation ID to continue.
message (string, optional): User message text.
choices (string, optional): Button/option choice indices as JSON array string.
sendFormInput (string, optional): Form submission data as JSON string.
files (array[binary], optional): Files to upload.
mediaFiles (array[binary], optional): Media files to upload.
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
Existing conversation ID to continue
User message text
Button/option choice indices (JSON array string, e.g. '[0, 1]')
Form submission data (JSON string)
Per-turn shared KnowledgeBase or Folder node IDs as JSON array of global IDs
Per-turn personal KnowledgeBase or Folder node IDs as JSON array of global IDs
Per-turn web search URLs as JSON array of strings
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.
POST /webapi/v2/apps/{app_id}/run_conversation HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 259
{
"conversationId": "text",
"message": "text",
"choices": "text",
"sendFormInput": "text",
"fileIds": "text",
"sharedKnowledgeBaseNodeIds": "text",
"personalKnowledgeBaseNodeIds": "text",
"webSites": "text",
"files": [
"binary"
],
"media_files": [
"binary"
],
"form_files": [
"binary"
]
}No content
This API allows you to retrieve the project's cognitive configuration as JSON.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
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/cognitive_config HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This API allows you to partially update cognitive configuration fields.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
A flat JSON object where each key is a cognitive config field name and the value is the new value. Only provided fields are updated.
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.
PATCH /webapi/v2/cognitive_config HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This API allows you to list LLM apps in the project with optional filtering by published status and user.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Query Parameters
published (string, optional): Filter by published status. Must be
trueorfalse.id (array[string], optional): Filter by specific app IDs.
locale (string, optional): Locale for localized app 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
get Apps API success response
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/apps HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": [
{
"id": "text",
"name": "text",
"type": "single_action",
"description": "text",
"category": "text",
"app_from": "text",
"app_url": "text"
}
]
}This API allows you to create a new LLM app (currently supports single_action type only).
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
type (string, required): App type. Currently only
single_actionis supported.name (string, required): Name of the app.
description (string, required): Description of the app.
category (string, required): Category of the app.
published (boolean, required): Whether the app is published.
enabled (boolean, required): Whether the app is enabled.
single_action_app_input (object, required): Single action app configuration including name, description, inputs, llm_model, and messages.
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
create App API success response
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/apps HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 472
{
"user_id": "text",
"type": "single_action",
"name": "text",
"description": "text",
"category": "text",
"published": true,
"enabled": true,
"single_action_app_input": {
"name": "text",
"description": "text",
"llm_model": "text",
"selected_llm_processing_method": "stuff",
"selected_map_reduce_input_variable_name": "text",
"inputs": [
{
"name": "text",
"value": "text",
"placeholder": "text",
"input_type": "text",
"options": [
{
"name": "text",
"value": "text"
}
]
}
],
"messages": [
{
"role": "system",
"content": "text"
}
]
}
}{
"result": {
"id": "text"
}
}This API allows you to retrieve a specific LLM app by its ID.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
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
Invalid request parameters.
No content
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/apps/{app_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
This API allows you to update an existing LLM app's properties.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
name (string, optional): Name of the app.
description (string, optional): Description of the app.
category (string, optional): Category of the app.
published (boolean, optional): Whether the app is published.
enabled (boolean, optional): Whether the app is enabled.
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
Invalid request parameters.
No content
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/apps/{app_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
This API allows you to delete an LLM app by its ID.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
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
Invalid request parameters.
No content
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/apps/{app_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
This API allows you to execute an LLM App (single action, campaign, or agent type). Supports both synchronous and streaming modes.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
chat (object, optional): Chat message input for conversational apps. Contains
message(string),source(object), anduseNodeDefaultInputSource(boolean).inputs (object, optional): Input variables for the LLM App. Structure depends on the app type.
mode (string, optional): Execution mode. Must be
sync,stream, orbackground. Defaults to sync.isStateful (boolean, optional): Whether to maintain conversation state. Defaults to false.
conversationId (string, optional): Conversation ID for continuing a previous conversation. Required when isStateful is true for follow-up messages.
llmModel (string, optional): Name of the LLM model to use. Must be a registered and activated model.
llmPromptId (string, optional): ID of the LLM prompt to use.
gaPromptGroupId (string, optional): ID of the Generative Answer prompt group to use.
temperature (number, optional): Controls output randomness. Range is 0 to 2. Defaults to 0.
requiredVariables (array[string], optional): List of required variable names to include in the response.
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
Execution mode. Use "sync" for synchronous responses or "stream" for streaming responses. Default is "sync".
syncPossible values: Whether to maintain conversation state. Set to true to enable conversation history. When true, conversationId must be provided for follow-up messages.
falseConversation ID for continuing a previous conversation. Required when isStateful is true for follow-up messages. Use the conversation.id from the previous response.
Name of the LLM model to use. Must be a registered model name (lowercase). See model registration documentation for available models.
ID of the LLM prompt to use
ID of the Generative Answer prompt group to use
Controls the randomness of the output. Higher values make the output more random. Range is typically 0 to 2.
0List of required variable names to include in the response
Successfully executed the LLM App
Error message if an error occurred
Bad request
Unauthorized - Invalid or missing authentication token
Access denied. The project is inactive or the request IP is not allowed.
Rate limit exceeded
Internal server error
POST /webapi/apps/{app_id}/run HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 355
{
"chat": {
"message": "text",
"source": {
"knowledgeBaseIds": [
"text"
],
"folderIds": [
"text"
],
"webSites": [
"text"
]
},
"useNodeDefaultInputSource": false
},
"inputs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"mode": "sync",
"isStateful": false,
"conversationId": "text",
"llmModel": "text",
"llmPromptId": "text",
"gaPromptGroupId": "text",
"temperature": 0,
"requiredVariables": [
"text"
]
}{
"result": {
"id": "text",
"name": "text",
"type": "campaign",
"category": "General",
"responses": [
{
"id": "text",
"type": "text",
"message": "text",
"source": {},
"sender": "text",
"createdAt": "2024-09-23T04:53:12.675",
"completed": true,
"citations": [
{
"clueId": "text",
"source": "text",
"title": "text",
"knowledgeBaseId": "text",
"pageNo": 1,
"url": "text",
"text": "text"
}
],
"error": {
"timestamp": 1,
"nodeId": "text",
"nodeType": "text",
"errorType": "text",
"errorObject": {}
},
"intermediateStep": {
"completed": true,
"key": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"statusMessage": "text",
"markdownMessage": "text"
}
}
],
"variables": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"conversation": {
"id": "text",
"state": "text"
}
},
"error": "text"
}This API allows you to execute a skill and retrieve the final text answer. It can also be used for entity extraction if the skill is designed for that purpose.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
id (string, required): The skill ID. You can find it in the URL when viewing a skill in the dashboard (e.g.,
https://app.alli.ai/projects/PROJECT_ID/campaigns/SKILL_ID).text (string, required): The input text for the skill execution.
variables (object, optional): A JSON object to set variables in the skill before execution.
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
This is a skill id. If you click a skill in the Alli Dashboard, the URL is something like https://app.alli.ai/projects/PROJECT_ID/campaigns/SKILL_ID. Please put SKILL_ID here.
This is an input text for the skill execution.
Variables is a JSON object to set the variables in the skill. To learn more about variables in Alli, please see the user guide.
Skill executed successfully
The final text output from the skill execution.
If any error happens, the error message will be included here.
Bad request
Unauthorized
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/skill HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"id": "text",
"text": "text",
"variables": {}
}{
"result": "text",
"errors": [
"text"
]
}Start a conversation using a Skill. Note: this endpoint is currently only compatible with Message Node, Q&A Node, and Documents Node.
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
Used to match which Skill to start the conversation with.
Successfully started conversation
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/start_conversation HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"placement": "text"
}{
"result": {
"conversation": {
"id": "text",
"project": {
"nluLanguage": "text"
},
"chats": {
"edges": [
{
"node": {
"id": "text",
"message": "text",
"createdAt": 1,
"chatOptionInfos": [
{
"shortenOption": "text",
"longOption": "text",
"style": {
"bgColor": "text",
"bold": true,
"fontColor": "text",
"italic": true,
"lineColor": "text",
"underline": true
},
"meta": "text"
}
],
"isDeleted": true
}
}
]
}
}
},
"errors": {}
}End a conversation from the agent side.
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 conversation ID to end
Conversation ended successfully
Error information if the request fails
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/end_conversation_by_agent HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13
{
"id": "text"
}{
"result": {
"conversation": {
"id": "text",
"completedTime": 1,
"state": "text",
"__typename": "text"
},
"__typename": "text"
},
"errors": {}
}Send a message as the user for an existing conversation. Note: this endpoint is currently only compatible with Message Node, Q&A Node, and Documents Node.
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 message to send in the conversation. Cannot be null or an empty string.
Unique id for the conversation you want to send a message in.
Successfully sent chat
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/send_chat HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"message": "text",
"conversationId": "text"
}{
"result": {
"responses": [
{
"id": "text",
"message": "text",
"createdAt": 1,
"chatOptionInfos": [
{
"shortenOption": "text",
"longOption": "text",
"style": {
"bgColor": "text",
"bold": true,
"fontColor": "text",
"italic": true,
"lineColor": "text",
"underline": true
},
"meta": "text"
}
],
"isDeleted": true
}
],
"state": "text"
},
"errors": {}
}Last updated