Apps
App related APIs
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
앱 API 성공 답변 받기
GET /webapi/apps HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
앱 API 성공 답변 받기
{
"result": [
{
"id": "text",
"name": "text",
"type": "single_action",
"description": "text",
"category": "text",
"app_from": "text",
"app_url": "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
앱 API 성공 답변 생성
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"
}
]
}
}앱 API 성공 답변 생성
{
"result": {
"id": "text"
}
}이 API는 스킬을 실행하고 최종 텍스트 답변을 JSON 포맷으로 반환합니다. 이 API는 스킬이 그 목적을 위해 설계된 경우 엔티티 추출에 사용할 수 있습니다.
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
스킬 ID입니다. Alli 대시보드에서 스킬을 클릭하면 URL이 https://app.alli.ai/projects/PROJECT_ID/campaigns/SKILL_ID와 같이 표시됩니다. 여기에 SKILL_ID를 입력해 주세요.
기술 실행을 위한 입력 텍스트입니다.
변수는 스킬의 변수를 설정하기 위한 JSON 객체입니다. Alli에서 변수에 대해 더 알아보려면 유저 가이드를 True조해 주세요.
성공적으로 실행되었습니다.
잘못된 요청
허가되지 않음
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"
]
}생성적 답변 API는 비정형 텍스트 문서, Q&A, 심지어 복잡한 표에서도 답을 찾습니다. 여러 출처에서 정보를 종합하여 유저 쿼리에 대한 포괄적인 답변을 제공합니다.
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
쿼리 문자열입니다.
답변을 생성할 때 선택한 LLM을 활용하십시오. 기본 모델은 GPT4o입니다. 사용 가능한 옵션은 문서를 True로 변경하십시오.
답변의 형식을 결정하여 통합을 용이하게 만듭니다. 허용 가능한 값은 DRAFTJS 및 MARKDOWN입니다. 기본 형식은 DRAFTJS입니다.
후속 질문을 사용하기 위해서는 이전 대화 역사가 필요합니다. 대화 역사는 threadId로 관리됩니다. isStateful 옵션을 True로 설정하고 threadId를 입력하면 이전 대화 역사를 True고하여 쿼리가 다시 작성됩니다. 기본값 = False.
threadId는 isStateful = True일 때 사용됩니다. 처음 대화를 시작할 때는 비워서 보내고, 그 다음 질의부터는 출력에서 threadId를 사용하여 보냅니다. 그러나 처음부터 threadId를 설정하려면 UUID로 작성하여 보내십시오. 예시 UUID - 36e7bb2b-1063-47ec-. 기본값 = None.
프로젝트에서 답변 생성에 사용할 그룹 프롬프트를 선택해 주세요. ID는 설정 페이지 내에서 그룹 프롬프트를 볼 때 URL에 위치해 있습니다. 이는 특정 작업을 위해 수정된 여러 다른 그룹 프롬프트가 있는 프로젝트에 매우 유용한 옵션입니다.
데이터를 스트림 또는 동기식으로 출력할지 여부. 현재 사용 가능한 값: sync 또는 stream (기본값=sync). 스트림 모드에서는 .json 문자열이 동기식과 동일한 출력 형식으로 스트리밍으로 출력됩니다.
단서를 사용하여 단서로 사용된 문서의 텍스트를 포함할지 여부. 기본값 = False. 단서가 활성화된 경우에만 작동합니다.
출력에 생성 답변을 만드는 데 사용될 단서를 포함할지 여부. 기본값 = False.
생성적 답변이 데이터를 찾기 위한 원본 데이터의 범위를 지정합니다. 현재 사용 가능한 값은 다음과 같습니다: 웹, 질의답변, 문서이며, 목록 형식으로 데이터를 입력합니다. 예를 들어 -> ["웹", "질의답변"]
출력의 무작위성을 제어합니다. 값이 클수록 출력이 더 무작위가 됩니다. 기본값 = 0.
검색을 특정 지식베이스 ID로 제한합니다.
검색을 특정 폴더 ID로 제한합니다.
성공적으로 생성된 답변
잘못된 요청
무단의
속도 제한 초과
POST /webapi/generative_answer HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 476
{
"query": "text",
"model": "text",
"answerFormat": "text",
"isStateful": true,
"threadId": "123e4567-e89b-12d3-a456-426614174000",
"promptGroupId": "text",
"mode": "text",
"clueText": true,
"clues": true,
"hashtags": {
"qnaInclude": [
"text"
],
"qnaIncludeOption": "or",
"qnaExclude": [
"text"
],
"qnaExcludeOption": "or",
"docsInclude": [
"text"
],
"docsIncludeOption": "or",
"docsExclude": [
"text"
],
"docsExcludeOption": "or"
},
"search_from": [
"text"
],
"temperature": 1,
"knowledgeBaseIds": [
"text"
],
"folderIds": [
"text"
]
}{
"answer": {},
"answerHash": "text",
"confidence": 1,
"effectiveConfidence": 1,
"documentId": "text",
"documentName": "text",
"hashtags": [],
"pageNo": 1,
"createdDate": "2025-08-28",
"agentFeedback": {},
"userFeedback": {},
"body": "text",
"css": "text",
"pdfPreview": "text",
"folder": "text",
"editor": [
"text"
],
"viewer": [
"text"
],
"threadId": "text",
"fuQuestion": "text",
"intent": "text",
"clues": []
}스킬을 사용하여 대화를 시작하십시오. True고: 이 엔드포인트는 현재 메시지 노드, Q&A 노드 및 문서 노드와만 호환됩니다.
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
어떤 스킬로 대화를 시작할지 매칭하는 데 사용됩니다.
성공적으로 대화를 시작했습니다.
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.
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
Your API key can be found in your dashboard Settings menu, under the General tab.
The conversation ID to end
Conversation ended successfully
POST /webapi/end_conversation_by_agent HTTP/1.1
Host: backend.alli.ai
API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 13
{
"id": "text"
}Conversation ended successfully
{
"result": {
"conversation": {
"id": "text",
"completedTime": 1,
"state": "text",
"__typename": "text"
},
"__typename": "text"
},
"errors": {}
}기존 대화에 대해 유저로 메시지를 보냅니다. True고: 이 엔드포인트는 현재 메시지 노드, Q&A 노드 및 문서 노드와만 호환됩니다.
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
대화에서 보낼 메시지. null이거나 빈 문자열일 수 없습니다.
메시지를 보내고자 하는 대화의 고유 ID입니다.
대화 전송 성공
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": {}
}Was this helpful?