App Market

App related APIs

List Apps

get

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

/webapi/v2/apps

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

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

/webapi/v2/apps/{app_id}

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

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

/webapi/v2/apps/{app_id}

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

Run Conversation App

post

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

/webapi/v2/apps/{app_id}/run_conversation

Run a campaign app with streaming response.

Executes a campaign (skill/agent) app and returns a streaming response. Supports text messages, button choices, file/media uploads, and form submissions. Always uses multipart/form-data. Pass send_form_input as a JSON string.

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

multipart/form-data

conversationIdany ofOptional

Existing conversation ID to continue

stringOptional

or

nullOptional

messageany ofOptional

User message text

stringOptional

or

nullOptional

choicesany ofOptional

Button/option choice indices (JSON array string, e.g. '[0, 1]')

stringOptional

or

nullOptional

sendFormInputany ofOptional

Form submission data (JSON string)

stringOptional

or

nullOptional

filesstring · binary[]Optional

media_filesstring · binary[]Optional

Responses

200

OK

No content

post

/webapi/v2/apps/{app_id}/run_conversation

HTTPcURLJavaScriptPython

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

{
  "conversationId": "text",
  "message": "text",
  "choices": "text",
  "sendFormInput": "text",
  "files": [
    "binary"
  ],
  "media_files": [
    "binary"
  ]
}

200

OK

No content

Get Cognitive Config

get

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

/webapi/v2/cognitive_config

Return the project's cognitive_config as JSON.

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

OK

application/json

Other propertiesanyOptional

get

/webapi/v2/cognitive_config

HTTPcURLJavaScriptPython

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

200

OK

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Patch Cognitive Config

patch

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

/webapi/v2/cognitive_config

Partial update of cognitive_config fields.

Request body: flat JSON dict of field_name -> value. Only provided fields are updated; others are unchanged.

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

Other propertiesanyOptional

Responses

200

OK

application/json

Other propertiesanyOptional

patch

/webapi/v2/cognitive_config

HTTPcURLJavaScriptPython

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

200

OK

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

get

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

/webapi/apps

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

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

/webapi/apps

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

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

/webapi/apps/{app_id}/run

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: 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-05-13T03:24:14.730Z",
          "statusMessage": "text",
          "markdownMessage": "text"
        }
      }
    ],
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "conversation": {
      "id": "text",
      "state": "text"
    }
  },
  "error": "text"
}

Executing a Skill

post

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

/webapi/skill

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

Start Conversation

post

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

/webapi/start_conversation

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

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

/webapi/end_conversation_by_agent

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

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

/webapi/send_chat

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