Apps

App related APIs

Get List Apps

get

Get a list of apps. The apps are sorted by weight in descending order by default.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Query parameters

searchTermany ofOptional

Search term for app name or description

stringOptional

or

nullOptional

categoriesany ofOptional

Filter by app categories

string[]Optional

or

nullOptional

typeany ofOptional

Filter by app type

stringOptional

or

nullOptional

publishedany ofOptional

Filter by published status

booleanOptional

or

nullOptional

pageSizeinteger · min: 1 · max: 100Optional

Number of apps per page

Default: 50

cursorany ofOptional

Cursor for pagination

stringOptional

or

nullOptional

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

Response for listing apps.

cursorany ofOptional

Cursor for pagination

stringOptional

or

nullOptional

get

/webapi/v2/apps

HTTPcURLJavaScriptPython

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

200

OK

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

Get App By Id

get

Get a specific app by ID.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

app_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

App information.

idstringRequired

Unique ID of the app

namestringRequired

Name of the app

descriptionany ofOptional

Description of the app

stringOptional

or

nullOptional

typestringRequired

Type of the app

categorystringRequired

Category of the app

publishedbooleanRequired

Whether the app is published

get

/webapi/v2/apps/{app_id}

HTTPcURLJavaScriptPython

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

200

OK

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

Update App

patch

Update an app.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

app_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

Request schema for updating an app.

nameany ofOptional

Name of the app

stringOptional

or

nullOptional

descriptionany ofOptional

Description of the app

stringOptional

or

nullOptional

categoryany ofOptional

Category of the app

stringOptional

or

nullOptional

publishedany ofOptional

Whether the app is published

booleanOptional

or

nullOptional

agentPermissionany ofOptional

Agent permission

or

nullOptional

userPermissionany ofOptional

User permission

or

nullOptional

Responses

200

OK

application/json

App information.

idstringRequired

Unique ID of the app

namestringRequired

Name of the app

descriptionany ofOptional

Description of the app

stringOptional

or

nullOptional

typestringRequired

Type of the app

categorystringRequired

Category of the app

publishedbooleanRequired

Whether the app is published

patch

/webapi/v2/apps/{app_id}

HTTPcURLJavaScriptPython

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

200

OK

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

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Query parameters

publishedstringOptional

idstring[]Optional

localestringOptional

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

get Apps API success response

application/json

get

/webapi/apps

HTTPcURLJavaScriptPython

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

200

get Apps API success response

{
  "result": [
    {
      "id": "text",
      "name": "text",
      "type": "single_action",
      "description": "text",
      "category": "text",
      "app_from": "text",
      "app_url": "text"
    }
  ]
}

post

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

user_idstringOptional

typestring · enumRequiredPossible values:

namestringRequired

descriptionstringRequired

categorystringRequired

publishedbooleanRequired

enabledbooleanRequired

Responses

200

create App API success response

application/json

post

/webapi/apps

HTTPcURLJavaScriptPython

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

200

create App API success response

{
  "result": {
    "id": "text"
  }
}

Run LLM App

post

Execute an LLM App via REST API. Supports JSON requests.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Path parameters

app_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

modestring · enumOptional

Execution mode. Use "sync" for synchronous responses or "stream" for streaming responses. Default is "sync".

Default: syncPossible values:

isStatefulbooleanOptional

Whether to maintain conversation state. Set to true to enable conversation history. When true, conversationId must be provided for follow-up messages.

Default: false

conversationIdstringOptional

Conversation ID for continuing a previous conversation. Required when isStateful is true for follow-up messages. Use the conversation.id from the previous response.

llmModelstringOptional

Name of the LLM model to use. Must be a registered model name (lowercase). See model registration documentation for available models.

llmPromptIdstringOptional

ID of the LLM prompt to use

gaPromptGroupIdstringOptional

ID of the Generative Answer prompt group to use

temperaturenumberOptional

Controls the randomness of the output. Higher values make the output more random. Range is typically 0 to 2.

Default: 0

requiredVariablesstring[]Optional

List of required variable names to include in the response

Responses

200

Successfully executed the LLM App

application/json

errorstringOptional

Error message if an error occurred

400

Bad request

401

Unauthorized - Invalid or missing authentication token

429

Rate limit exceeded

500

Internal server error

post

/webapi/apps/{app_id}/run

HTTPcURLJavaScriptPython

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: 321

{
  "chat": {
    "message": "text",
    "source": {
      "knowledgeBaseIds": [
        "text"
      ],
      "folderIds": [
        "text"
      ],
      "webSites": [
        "text"
      ]
    }
  },
  "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-03-02T18:02:31.013Z",
          "statusMessage": "text",
          "markdownMessage": "text"
        }
      }
    ],
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "conversation": {
      "id": "text",
      "state": "text"
    }
  },
  "error": "text"
}

Executing a Skill

post

This API executes a skill and returns the final text answer as JSON format. This API can be used for entity extraction if the skill is designed for that purpose.

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

idstringRequired

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.

textstringRequired

This is an input text for the skill execution.

variablesobjectOptional

Variables is a JSON object to set the variables in the skill. To learn more about variables in Alli, please see the user guide.

Responses

200

Skill executed successfully

application/json

resultstringOptional

The final text output from the skill execution.

errorsstring[]Optional

If any error happens, the error message will be included here.

400

Bad request

application/json

401

Unauthorized

application/json

post

/webapi/skill

HTTPcURLJavaScriptPython

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

Generative Answer API

post

Generative Answer API finds an answer from your unstructured text documents, Q&A, and even from complex tables. It synthesizes information from various sources to provide comprehensive responses to user queries.

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

querystringOptional

This is a query string.

modelstringOptional

Utilize the LLM of your choice when generating answers. Default model is GPT4o. Please see documentation for available options.

answerFormatstringOptional

Determine the format of the response given for easier integrations. Acceptable values are DRAFTJS and MARKDOWN. Default format is DRAFTJS.

isStatefulbooleanOptional

To use follow-up question, previous conversation history is required. The conversation history is managed by threadId. If you set isStateful option to True and enter a threadId, the query will be rewritten with reference to the previous conversation history. Default = False.

threadIdstring · uuidOptional

threadId is used when isStateful = True. The first time you start a conversation, send it empty, and from the next query on, send it using the threadId from the output. However, if you want to set the threadId from the beginning, write it as a UUID and send it. Example UUID - 36e7bb2b-1063-47ec-. Default = None.

promptGroupIdstringOptional

Select which group prompt from your project to use for generating responses. The ID is located within the URL when viewing the group prompt within the Settings page. This is a very helpful option for a project with multiple different group prompts that are altered for specific tasks.

modestringOptional

Whether to output data as stream or sync. Current available values: sync OR stream (default=sync). When in stream mode, .json strings with the same output format as sync are outputted as streaming.

clueTextbooleanOptional

Whether to include the text of the document used as a clue. Default = False. ONLY works if clues is enabled.

cluesbooleanOptional

Whether to include clues in the output that will be used to create a generative answer. Default = False.

includeCitationsbooleanOptional

Whether to include detailed citation information in the response. Citations provide structured references to source documents used in generating the answer. Default = False.

search_fromstring[]Optional

Specifies the range of source data for Generative Answer to find data from. Currently available values are: web, qna, document, and enter data in the form of a list. For example -> ["web", "qna"]

temperaturenumberOptional

Controls the randomness of the output. Higher values make the output more random. Default = 0.

knowledgeBaseIdsstring[]Optional

(Legacy) Limits the search to specific knowledge base IDs. Use 'source' parameter instead for better control over shared/personal documents.

folderIdsstring[]Optional

(Legacy) Limits the search to specific folder IDs. Use 'source' parameter instead for better control over shared/personal documents.

Responses

200

Successfully generated answer

application/json

answerobjectOptional

It's the answer extracted from uploaded documents in the dashboard, formatted according to the answerFormat parameter.

answerHashstringOptional

This is used to identify the answer to give or cancel feedback.

confidencenumberOptional

It shows the confidence value from AI model. Shown as a number value between 0 and 1.

effectiveConfidencenumberOptional

When you provide feedback to the query result, it automatically trains the AI model. Effective confidence is the adjusted score with these users' and agents' feedback. Shown as a number value between 0 and 1.

documentIdstringOptional

The document's ID where the answer is extracted from.

documentNamestringOptional

The document's name where the answer is extracted from.

hashtagsarrayOptional

The hashtags attached to the document.

pageNointegerOptional

The page number in the document where the answer was derived.

createdDatestring · dateOptional

The date when the document was uploaded.

agentFeedbackobjectOptional

The feedback from agents (through dashboard and REST calls) about this document.

userFeedbackobjectOptional

The feedback from users about this document.

bodystringOptional

If returnPreview is true in the request, the html body of the document search preview is displayed.

cssstringOptional

If returnPreview is true in the request, the css of the document search preview is displayed.

pdfPreviewstringOptional

If returnPdfPreview is true in the request, the URL to a PDF preview of the document with the answer highlighted is displayed. Note that the URL can be restricted using the Download IP Allowlist setting.

folderstringOptional

If the answer is found from a folder under the Documents database, the folder name will be returned here.

editorstring[]Optional

List of the agents' email who has the editor access to the documents (if they're set in the Alli dashboard).

viewerstring[]Optional

List of the agents' email who has the viewer access to the documents (if they're set in the Alli dashboard).

threadIdstringOptional

A UUID that can be used for follow-up questions when isStateful is true.

fuQuestionstringOptional

Suggested follow-up question for the user when isStateful is true.

intentstringOptional

The detected intent of the query.

cluesarrayOptional

If clues is true in the request, the sources used to generate the answer are returned here.

400

Bad request

application/json

401

Unauthorized

application/json

429

Rate limit exceeded

application/json

post

/webapi/generative_answer

HTTPcURLJavaScriptPython

POST /webapi/generative_answer HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 609

{
  "query": "text",
  "model": "text",
  "answerFormat": "text",
  "isStateful": true,
  "threadId": "123e4567-e89b-12d3-a456-426614174000",
  "promptGroupId": "text",
  "mode": "text",
  "clueText": true,
  "clues": true,
  "includeCitations": true,
  "hashtags": {
    "qnaInclude": [
      "text"
    ],
    "qnaIncludeOption": "or",
    "qnaExclude": [
      "text"
    ],
    "qnaExcludeOption": "or",
    "docsInclude": [
      "text"
    ],
    "docsIncludeOption": "or",
    "docsExclude": [
      "text"
    ],
    "docsExcludeOption": "or"
  },
  "search_from": [
    "text"
  ],
  "temperature": 1,
  "source": {
    "sharedKnowledgeBaseNodeIds": [
      "text"
    ],
    "personalKnowledgeBaseNodeIds": [
      "text"
    ],
    "webSites": [
      "text"
    ]
  },
  "knowledgeBaseIds": [
    "text"
  ],
  "folderIds": [
    "text"
  ]
}

{
  "answer": {},
  "answerHash": "text",
  "confidence": 1,
  "effectiveConfidence": 1,
  "documentId": "text",
  "documentName": "text",
  "hashtags": [],
  "pageNo": 1,
  "createdDate": "2026-03-02",
  "agentFeedback": {},
  "userFeedback": {},
  "body": "text",
  "css": "text",
  "pdfPreview": "text",
  "folder": "text",
  "editor": [
    "text"
  ],
  "viewer": [
    "text"
  ],
  "threadId": "text",
  "fuQuestion": "text",
  "intent": "text",
  "clues": [],
  "citations": [
    {
      "index": 1,
      "clueId": "text",
      "source": "text",
      "title": "text",
      "pageNo": 1,
      "knowledgeBaseId": "text",
      "faqId": "text",
      "url": "text",
      "text": "text"
    }
  ]
}

Start Conversation

post

Start a conversation using a Skill. Note: this endpoint is currently only compatible with Message Node, Q&A Node, and Documents Node.

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

placementstringOptional

Used to match which Skill to start the conversation with.

Responses

200

Successfully started conversation

application/json

errorsobject · nullableOptional

post

/webapi/start_conversation

HTTPcURLJavaScriptPython

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

200

Successfully started conversation

{
  "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 Conversation by Agent

post

End a conversation from the agent side.

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

idstringRequired

The conversation ID to end

Responses

200

Conversation ended successfully

application/json

errorsobject · nullableOptional

Error information if the request fails

post

/webapi/end_conversation_by_agent

HTTPcURLJavaScriptPython

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

200

Conversation ended successfully

{
  "result": {
    "conversation": {
      "id": "text",
      "completedTime": 1,
      "state": "text",
      "__typename": "text"
    },
    "__typename": "text"
  },
  "errors": {}
}

Send Chat

post

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.

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

messagestringRequired

The message to send in the conversation. Cannot be null or an empty string.

conversationIdstringRequired

Unique id for the conversation you want to send a message in.

Responses

200

Successfully sent chat

application/json

errorsobject · nullableOptional

post

/webapi/send_chat

HTTPcURLJavaScriptPython

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

200

Successfully sent chat

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