For the complete documentation index, see llms.txt. This page is also available as Markdown.

App Market

Knowledge base related APIs

List Apps

get
/webapi/v2/apps

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

Authorizations
API-KEYstringRequired

Your API key for authentication

Query parameters
searchTermstring · nullableOptional

Search term for app name or description

categoriesstring[] · nullableOptional

Filter by app categories

typestring · nullableOptional

Filter by app type

publishedboolean · nullableOptional

Filter by published status

pageSizeinteger · min: 1 · max: 100Optional

Number of apps per page

Default: 50
cursorstring · nullableOptional

Cursor for pagination

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.

cursorstring · nullableOptional

Cursor for pagination

get/webapi/v2/apps

Get App

get
/webapi/v2/apps/{app_id}

Get a specific app by ID.

Authorizations
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

descriptionstring · nullableOptional

Description of the app

typestringRequired

Type of the app

categorystringRequired

Category of the app

publishedbooleanRequired

Whether the app is published

get/webapi/v2/apps/{app_id}

Update App

patch
/webapi/v2/apps/{app_id}

Update an app.

Authorizations
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

Request schema for updating an app.

namestring · nullableOptional

Name of the app

descriptionstring · nullableOptional

Description of the app

categorystring · nullableOptional

Category of the app

publishedboolean · nullableOptional

Whether the app is published

Responses
200

OK

application/json

App information.

idstringRequired

Unique ID of the app

namestringRequired

Name of the app

descriptionstring · nullableOptional

Description of the app

typestringRequired

Type of the app

categorystringRequired

Category of the app

publishedbooleanRequired

Whether the app is published

patch/webapi/v2/apps/{app_id}

Conversation App 실행

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

캠페인 App을 스트리밍 응답으로 실행합니다.

캠페인(스킬/에이전트) App을 실행하고 스트리밍 응답을 반환합니다. 텍스트 메시지, 버튼 선택, 파일/미디어 업로드, 폼 제출을 지원합니다. 항상 multipart/form-data를 사용합니다. send_form_input은 JSON 문자열로 전달하세요.

Authorizations
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
conversationIdstring · nullableOptional

Existing conversation ID to continue

messagestring · nullableOptional

User message text

choicesstring · nullableOptional

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

sendFormInputstring · nullableOptional

Form submission data (JSON string)

fileIdsstring · nullableOptional
filesstring · binary[]Optional
media_filesstring · binary[]Optional
form_filesstring · binary[]Optional
Responses
200

OK

No content

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

No content

Cognitive Config 조회

get
/webapi/v2/cognitive_config

프로젝트의 cognitive_config를 JSON으로 반환합니다.

Authorizations
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

Cognitive Config 부분 수정

patch
/webapi/v2/cognitive_config

cognitive_config 필드를 부분 수정합니다.

요청 본문: field_name -> value 형태의 플랫 JSON 딕셔너리. 전달된 필드만 업데이트되며, 나머지는 변경되지 않습니다.

Authorizations
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
Other propertiesanyOptional
Responses
200

OK

application/json
Other propertiesanyOptional
patch/webapi/v2/cognitive_config
get
/webapi/apps
Authorizations
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

앱 API 성공 답변 받기

application/json
get/webapi/apps
post
/webapi/apps
Authorizations
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
user_idstringOptional
typestring · enumRequiredPossible values:
namestringRequired
descriptionstringRequired
categorystringRequired
publishedbooleanRequired
enabledbooleanRequired
Responses
200

앱 API 성공 답변 생성

application/json
post/webapi/apps

LLM App 실행

post
/webapi/apps/{app_id}/run

REST API를 통해 LLM App을 실행합니다. JSON 요청을 지원합니다.

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

post/webapi/apps/{app_id}/run

기술 실행

post
/webapi/skill

이 API는 스킬을 실행하고 최종 텍스트 답변을 JSON 포맷으로 반환합니다. 이 API는 스킬이 그 목적을 위해 설계된 경우 엔티티 추출에 사용할 수 있습니다.

Authorizations
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
idstringRequired

스킬 ID입니다. Alli 대시보드에서 스킬을 클릭하면 URL이 https://app.alli.ai/projects/PROJECT_ID/campaigns/SKILL_ID와 같이 표시됩니다. 여기에 SKILL_ID를 입력해 주세요.

textstringRequired

기술 실행을 위한 입력 텍스트입니다.

variablesobjectOptional

변수는 스킬의 변수를 설정하기 위한 JSON 객체입니다. Alli에서 변수에 대해 더 알아보려면 유저 가이드를 True조해 주세요.

Responses
200

성공적으로 실행되었습니다.

application/json
resultstringOptional

스킬 실행의 최종 텍스트 출력.

errorsstring[]Optional

오류가 발생하면, 오류 메시지가 여기에 포함됩니다.

post/webapi/skill

대화 시작

post
/webapi/start_conversation

스킬을 사용하여 대화를 시작하십시오. True고: 이 엔드포인트는 현재 메시지 노드, Q&A 노드 및 문서 노드와만 호환됩니다.

Authorizations
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
placementstringOptional

어떤 스킬로 대화를 시작할지 매칭하는 데 사용됩니다.

Responses
200

성공적으로 대화를 시작했습니다.

application/json
errorsobject · nullableOptional
post/webapi/start_conversation

End Conversation by Agent

post
/webapi/end_conversation_by_agent

End a conversation from the agent side.

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

대화 보내기

post
/webapi/send_chat

기존 대화에 대해 유저로 메시지를 보냅니다. True고: 이 엔드포인트는 현재 메시지 노드, Q&A 노드 및 문서 노드와만 호환됩니다.

Authorizations
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
messagestringRequired

대화에서 보낼 메시지. null이거나 빈 문자열일 수 없습니다.

conversationIdstringRequired

메시지를 보내고자 하는 대화의 고유 ID입니다.

Responses
200

대화 전송 성공

application/json
errorsobject · nullableOptional
post/webapi/send_chat

Last updated