# Apps
App related APIs
## Get List Apps
> Get a list of apps. The apps are sorted by weight in descending order by default.
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"apps","description":"App related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"AppsResponse":{"description":"Response for listing apps.","properties":{"apps":{"description":"List of apps","items":{"$ref":"#/components/schemas/App"},"title":"Apps","type":"array"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for pagination","title":"Cursor"}},"required":["apps"],"title":"AppsResponse","type":"object"},"App":{"description":"App information.","properties":{"id":{"description":"Unique ID of the app","title":"Id","type":"string"},"name":{"description":"Name of the app","title":"Name","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the app","title":"Description"},"type":{"description":"Type of the app","title":"Type","type":"string"},"category":{"description":"Category of the app","title":"Category","type":"string"},"published":{"description":"Whether the app is published","title":"Published","type":"boolean"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"}},"required":["id","name","type","category","published","agentPermission","userPermission"],"title":"App","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"The agent ID of the access agent","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"}}},"paths":{"/webapi/v2/apps":{"get":{"operationId":"django_server_llm_app_views_rest_apps_api_get_list_apps","summary":"Get List Apps","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"query","name":"searchTerm","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search term for app name or description","title":"Searchterm"},"required":false,"description":"Search term for app name or description"},{"in":"query","name":"categories","schema":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Filter by app categories","title":"Categories"},"required":false,"description":"Filter by app categories"},{"in":"query","name":"type","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by app type","title":"Type"},"required":false,"description":"Filter by app type"},{"in":"query","name":"published","schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter by published status","title":"Published"},"required":false,"description":"Filter by published status"},{"in":"query","name":"pageSize","schema":{"default":50,"description":"Number of apps per page","maximum":100,"minimum":1,"title":"Pagesize","type":"integer"},"required":false,"description":"Number of apps per page"},{"in":"query","name":"cursor","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for pagination","title":"Cursor"},"required":false,"description":"Cursor for pagination"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppsResponse"}}}}},"description":"Get a list of apps. The apps are sorted by weight in descending order by default.","tags":["apps"]}}}}
```
## Get App By Id
> Get a specific app by ID.
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"apps","description":"App related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"App":{"description":"App information.","properties":{"id":{"description":"Unique ID of the app","title":"Id","type":"string"},"name":{"description":"Name of the app","title":"Name","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the app","title":"Description"},"type":{"description":"Type of the app","title":"Type","type":"string"},"category":{"description":"Category of the app","title":"Category","type":"string"},"published":{"description":"Whether the app is published","title":"Published","type":"boolean"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"}},"required":["id","name","type","category","published","agentPermission","userPermission"],"title":"App","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"The agent ID of the access agent","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"}}},"paths":{"/webapi/v2/apps/{app_id}":{"get":{"operationId":"django_server_llm_app_views_rest_apps_api_get_app_by_id","summary":"Get App By Id","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"app_id","schema":{"title":"App Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}}},"description":"Get a specific app by ID.","tags":["apps"]}}}}
```
## Update App
> Update an app.
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"apps","description":"App related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}},"schemas":{"App":{"description":"App information.","properties":{"id":{"description":"Unique ID of the app","title":"Id","type":"string"},"name":{"description":"Name of the app","title":"Name","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the app","title":"Description"},"type":{"description":"Type of the app","title":"Type","type":"string"},"category":{"description":"Category of the app","title":"Category","type":"string"},"published":{"description":"Whether the app is published","title":"Published","type":"boolean"},"agentPermission":{"$ref":"#/components/schemas/AgentPermissionResponse","description":"Agent permission"},"userPermission":{"$ref":"#/components/schemas/UserPermissionResponse","description":"User permission"}},"required":["id","name","type","category","published","agentPermission","userPermission"],"title":"App","type":"object"},"AgentPermissionResponse":{"description":"Response model for agent permission.","properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroupResponse"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermissionResponse","type":"object"},"AccessAgent":{"properties":{"agentId":{"description":"The agent ID of the access agent","title":"Agentid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス方法"}},"required":["agentId","accessType"],"title":"AccessAgent","type":"object"},"ObjectAccessType":{"enum":["order_1_editor","order_2_reader"],"title":"ObjectAccessType","type":"string"},"AccessPermissionGroupResponse":{"description":"Response model for access permission group with name included.","properties":{"permissionGroupId":{"description":"The permission group ID","title":"Permissiongroupid","type":"string"},"permissionGroupName":{"description":"The permission group name","title":"Permissiongroupname","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"The access type"}},"required":["permissionGroupId","permissionGroupName","accessType"],"title":"AccessPermissionGroupResponse","type":"object"},"UserPermissionResponse":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermissionResponse","type":"object"},"UpdateAppRequest":{"description":"Request schema for updating an app.","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the app","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the app","title":"Description"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Category of the app","title":"Category"},"published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the app is published","title":"Published"},"agentPermission":{"anyOf":[{"$ref":"#/components/schemas/AgentPermission"},{"type":"null"}],"description":"Agent permission"},"userPermission":{"anyOf":[{"$ref":"#/components/schemas/UserPermission"},{"type":"null"}],"description":"User permission"}},"title":"UpdateAppRequest","type":"object"},"AgentPermission":{"properties":{"accessAgents":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessAgent"},"type":"array"},{"type":"null"}],"title":"Accessagents"},"accessPermissionGroups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccessPermissionGroup"},"type":"array"},{"type":"null"}],"title":"Accesspermissiongroups"},"viewAccessToAgent":{"title":"Viewaccesstoagent","type":"boolean"}},"required":["viewAccessToAgent"],"title":"AgentPermission","type":"object"},"AccessPermissionGroup":{"properties":{"permissionGroupId":{"description":"アクセス許可グループのグループID","title":"Permissiongroupid","type":"string"},"accessType":{"$ref":"#/components/schemas/ObjectAccessType","description":"アクセス許可グループの権限種別"}},"required":["permissionGroupId","accessType"],"title":"AccessPermissionGroup","type":"object"},"UserPermission":{"properties":{"ownUserIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ownuserids"},"customerGroups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Customergroups"},"viewAccessToUser":{"title":"Viewaccesstouser","type":"boolean"}},"required":["viewAccessToUser"],"title":"UserPermission","type":"object"}}},"paths":{"/webapi/v2/apps/{app_id}":{"patch":{"operationId":"django_server_llm_app_views_rest_apps_api_update_app","summary":"Update App","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"in":"path","name":"app_id","schema":{"title":"App Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}}},"description":"Update an app.","tags":["apps"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true}}}}}
```
## GET /webapi/apps
>
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"apps","description":"App related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/apps":{"get":{"tags":["apps"],"operationId":"getApps","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"published","in":"query","required":false,"schema":{"type":"string"}},{"name":"id","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"locale","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"アプリリストを正常に取得できました。","content":{"application/json":{"schema":{"type":"object","required":["result"],"properties":{"result":{"type":"array","items":{"type":"object","required":["id","name","type","description","category","app_from","app_url"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["single_action","skill"]},"description":{"type":"string"},"category":{"type":"string"},"app_from":{"type":"string"},"app_url":{"type":"string"}}}}}}}}}}}}}}
```
## POST /webapi/apps
>
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"apps","description":"App related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/apps":{"post":{"tags":["apps"],"operationId":"createApp","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","name","description","category","published","enabled","single_action_app_input"],"properties":{"user_id":{"type":"string"},"type":{"type":"string","enum":["single_action"]},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"published":{"type":"boolean"},"enabled":{"type":"boolean"},"single_action_app_input":{"type":"object","nullable":true,"required":["name","description","inputs","llm_model","messages"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"llm_model":{"type":"string"},"selected_llm_processing_method":{"type":"string","nullable":true,"enum":["stuff","map","map_reduce","chunk_map","chunk_map_reduce"]},"selected_map_reduce_input_variable_name":{"type":"string","nullable":true},"inputs":{"type":"array","items":{"type":"object","required":["name","value","input_type"],"properties":{"name":{"type":"string"},"value":{"type":"string"},"placeholder":{"type":"string","nullable":true},"input_type":{"type":"string","enum":["text","paragraph","single","multi","document_basic","document_advanced","image_basic","image_advanced"]},"options":{"type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}},"messages":{"type":"array","items":{"type":"object","required":["role","content"],"properties":{"role":{"type":"string","enum":["system","user"]},"content":{"type":"string"}}}}}}}}}}},"responses":{"200":{"description":"create App API success response","content":{"application/json":{"schema":{"type":"object","required":["result"],"properties":{"result":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## Run LLM App
> Execute an LLM App via REST API. Supports JSON requests.
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"apps","description":"App related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/apps/{app_id}/run":{"post":{"tags":["apps"],"operationId":"runApp","summary":"Run LLM App","description":"Execute an LLM App via REST API. Supports JSON requests.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chat":{"type":"object","description":"Chat message input for conversational apps","properties":{"message":{"type":"string","description":"The user's message/question"},"source":{"type":"object","description":"Source documents and knowledge bases for the chat","properties":{"knowledgeBaseIds":{"type":"array","items":{"type":"string"},"description":"List of knowledge base IDs to attach (for conversation history)"},"folderIds":{"type":"array","items":{"type":"string"},"description":"List of folder IDs to search"},"webSites":{"type":"array","items":{"type":"string"},"description":"List of web sites to search"}}}}},"inputs":{"type":"object","description":"Input variables for the LLM App. The structure depends on the app type. For single_action apps, this contains the app-specific input fields. For campaign apps, this can include prompt overrides and other configuration.\n","additionalProperties":true},"mode":{"type":"string","enum":["sync","stream","background"],"default":"sync","description":"Execution mode. Use \"sync\" for synchronous responses or \"stream\" for streaming responses. Default is \"sync\".\n"},"isStateful":{"type":"boolean","default":false,"description":"Whether to maintain conversation state. Set to true to enable conversation history. When true, conversationId must be provided for follow-up messages.\n"},"conversationId":{"type":"string","description":"Conversation ID for continuing a previous conversation. Required when isStateful is true for follow-up messages. Use the conversation.id from the previous response.\n"},"llmModel":{"type":"string","description":"Name of the LLM model to use. Must be a registered model name (lowercase). See model registration documentation for available models.\n"},"llmPromptId":{"type":"string","description":"ID of the LLM prompt to use"},"gaPromptGroupId":{"type":"string","description":"ID of the Generative Answer prompt group to use"},"temperature":{"type":"number","default":0,"description":"Controls the randomness of the output. Higher values make the output more random. Range is typically 0 to 2.\n"},"requiredVariables":{"type":"array","items":{"type":"string"},"description":"List of required variable names to include in the response"}}}}}},"responses":{"200":{"description":"Successfully executed the LLM App","content":{"application/json":{"schema":{"type":"object","required":["result"],"properties":{"result":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the LLM App that was executed"},"name":{"type":"string","description":"The name of the LLM App"},"type":{"type":"string","enum":["campaign","single_action","agent"],"description":"The type of LLM App"},"category":{"type":"string","description":"The category of the LLM App"},"responses":{"type":"array","description":"List of responses from the LLM App execution","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the response (Chat or SingleActionAppResult)"},"type":{"type":"string","description":"Node type (e.g., \"tn\", \"llm\")"},"message":{"type":"string","description":"The response message content"},"source":{"type":"object","description":"Source information for the message"},"sender":{"type":"string","description":"The sender of the message"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the response was created"},"completed":{"type":"boolean","description":"Whether the generation process has been completed"},"citations":{"type":"array","description":"Citation references used in the response","items":{"type":"object","properties":{"clueId":{"type":"string","description":"Unique ID of the clue"},"source":{"type":"string","description":"Source type (DOCUMENT, FAQ, WEB)"},"title":{"type":"string","description":"Title of the source document"},"knowledgeBaseId":{"type":"string","description":"Document ID of the clue"},"pageNo":{"type":"integer","description":"Page number of the clue"},"url":{"type":"string","description":"URL of the citation"},"text":{"type":"string","description":"Text excerpt of the citation"}}}},"error":{"type":"object","description":"Error information if an error occurred","properties":{"timestamp":{"type":"integer","description":"Timestamp of the error"},"nodeId":{"type":"string","description":"ID of the node where the error occurred"},"nodeType":{"type":"string","description":"Type of the node where the error occurred"},"errorType":{"type":"string","description":"Type of the error"},"errorObject":{"type":"object","description":"Additional error details"}}},"intermediateStep":{"type":"object","description":"Intermediate step information showing progress during generation. Used for displaying status messages during processing.\n","properties":{"completed":{"type":"boolean","description":"Whether the step is completed"},"key":{"type":"string","description":"Unique key for the step"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the step was created"},"statusMessage":{"type":"string","description":"Status message (e.g., \"Reasoning\")"},"markdownMessage":{"type":"string","description":"Markdown formatted message for the step"}}}}}},"variables":{"type":"object","description":"Variable values if requiredVariables was specified in the request. Contains the current values of project variables.\n","additionalProperties":true},"conversation":{"type":"object","description":"Conversation information when isStateful is true. Use the conversation.id for subsequent requests to continue the conversation.\n","properties":{"id":{"type":"string","description":"Conversation ID for continuing the conversation"},"state":{"type":"string","description":"Current state of the conversation"}}}}},"error":{"type":"string","description":"Error message if an error occurred"}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized - Invalid or missing authentication token"},"429":{"description":"Rate limit exceeded"},"500":{"description":"Internal server error"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"app_id","in":"path","required":true,"schema":{"type":"string"}}]}}}}
```
## スキルの実行
> このAPIはスキルを実行し、最終的なテキスト回答をJSON形式で返します。このAPIは、スキルがエンティティ抽出のために設計されている場合にも、使用できます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"apps","description":"App related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/skill":{"post":{"tags":["apps"],"operationId":"runSkill","summary":"スキルの実行","description":"このAPIはスキルを実行し、最終的なテキスト回答をJSON形式で返します。このAPIは、スキルがエンティティ抽出のために設計されている場合にも、使用できます。","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","text"],"properties":{"id":{"type":"string","description":"スキルのIDです。Alliのダッシュボードでスキルをクリックすると、URLはhttps://app.alli.ai/projects/PROJECT_ID/campaigns/SKILL_IDのようになります。URL内のSKILL_IDを入力してください。"},"text":{"type":"string","description":"スキルを実行するための入力テキストです。"},"variables":{"type":"object","description":"変数は、スキル内の変数を設定するためのJSONオブジェクトです。Alliにおける変数について詳は、ユーザーガイドをご覧ください。"}}}}}},"responses":{"200":{"description":"正常に実行されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","description":"スキル実行からの最終テキスト出力。"},"errors":{"type":"array","items":{"type":"string"},"description":"エラーが発生した場合、ここにエラーメッセージが含まれます。"}}}}}},"400":{"description":"不正なリクエスト","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"許可されていないリクエストです。","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## 回答生成
> 非構造化テキストドキュメント、Q\&A、複雑な表などから、さまざまな情報を統合して、ユーザーの問い合わせに対する包括的な回答を生成します。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"apps","description":"App related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/generative_answer":{"post":{"tags":["apps"],"operationId":"getGenerativeAnswer","summary":"回答生成","description":"非構造化テキストドキュメント、Q&A、複雑な表などから、さまざまな情報を統合して、ユーザーの問い合わせに対する包括的な回答を生成します。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","required":true,"description":"クエリ(質問文)"},"model":{"type":"string","description":"回答生成に利用するプロンプトを指定。デフォルトモデルはGPT4o。利用可能なオプションについてはドキュメントをご参照ください。"},"answerFormat":{"type":"string","description":"応答のフォーマットを決定します。指定できる値はDRAFTJSまたはMARKDOWNです。デフォルトのフォーマットはDRAFTJSです。"},"isStateful":{"type":"boolean","description":"フォローアップ質問を使用するには、以前の会話履歴が必要です。会話履歴はthreadIdによって管理されます。isStatefulオプションをTrueに設定し、threadIdを入力すると、クエリは以前の会話履歴を参照して書き換えられます。デフォルトはFalseです。"},"threadId":{"type":"string","format":"uuid","description":"threadIdはisStatefulがTrueの場合に使用されます。最初に会話を開始するときは、空のまま送信し、次のクエリ以降は出力からのthreadIdを使用して送信します。最初からthreadIdを設定したい場合は、UUIDとして記入し送信します。例: UUID - 36e7bb2b-1063-47ec-。デフォルト = None。"},"promptGroupId":{"type":"string","description":"回答生成に使用するプロジェクトのグループプロンプトを選択します。この設定は、デフォルトで準備されたグループプロンプトから変更を行い利用している場合などに有効です。\nIDはプロジェクト設定>プロンプト管理>回答生成タブの選択します。使用するグループプロンプトを選択した際に表示されるURLからIDが確認できます。\n例:https://app.alli.ai/projects/UHJvamVjdDo2NDljYTRjZDMzMGY2MDZkYWRjOPOjNjE=/settings/prompt-management/generative-answer/groups/TExNUHJvbXB0R3JvdXA6NjUzNzc3MzA5GHUyMGE2ZjlhM2Q5OTIw\n"},"mode":{"type":"string","description":"'データをsyncかstreamのどちらで出力するか設定します。(Default = sync)\nstreamモードの場合、syncと同じ出力形式のjson文字列がstreamとして出力されます。\n"},"clueText":{"type":"boolean","description":"clueTextはclues=Trueの時に利用できるオプションです。\nclueに用いたドキュメントのテキスト情報を含めるかどうか設定できます。(Default = False)\n"},"clues":{"type":"boolean","description":"回答を生成するために使用されたclueを出力に含めるかどうか設定できます。(Default = False)"},"includeCitations":{"type":"boolean","description":"回答に詳細な引用情報を含めるかの有無。回答の生成に使用されたソース文書を参照します。デフォルトはFalseです。\n"},"hashtags":{"type":"object","description":"ハッシュタグを使用してドキュメントとFAQの検索範囲を指定できます。 特定のハッシュタグを含めたり除外したり、選択したハッシュタグのオプションを指定することができます。\n例： { \"qnaInclude\" : [\"hash name\", \"hash name2\"], \"qnaIncludeOption\" : \"and\"/\"or\", \"qnaExclude\" : [\"hash name\", \"hash name2\"], \"qnaExcludeOption\" : \"and\"/\"or\", \"docsInclude\" : [\"hash name\", \"hash name2\"], \"docsIncludeOption\" : \"and\"/\"or\", \"docsExclude\" : [\"hash name\", \"hash name2\"], \"docsExcludeOption\" : \"and\"/\"or\", }\n","properties":{"qnaInclude":{"type":"array","items":{"type":"string"},"description":"検索に含めるFAQハッシュタグ"},"qnaIncludeOption":{"type":"string","enum":["and","or"],"default":"or","description":"FAQのハッシュタグにAND条件/OR条件を含む"},"qnaExclude":{"type":"array","items":{"type":"string"},"description":"検索から除外するFAQハッシュタグ"},"qnaExcludeOption":{"type":"string","enum":["and","or"],"default":"or","description":"検索から除外するFAQハッシュタグにAND条件/OR条件を含む"},"docsInclude":{"type":"array","items":{"type":"string"},"description":"検索に含めるドキュメントハッシュタグ"},"docsIncludeOption":{"type":"string","enum":["and","or"],"default":"or","description":"ドキュメントのハッシュタグにAND条件/OR条件を含む"},"docsExclude":{"type":"array","items":{"type":"string"},"description":"検索から除外するドキュメントハッシュタグ"},"docsExcludeOption":{"type":"string","enum":["and","or"],"default":"or","description":"検索から除外するドキュメントハッシュタグにAND条件/OR条件を含む"}}},"search_from":{"type":"array","items":{"type":"string"},"description":"回答生成時に検索するソース データの範囲を指定します。現在使用可能な値は、web、qna、document、およびリスト形式でのデータ入力です。\n例：[\"web\", \"qna\"]\n"},"temperature":{"type":"number","description":"出力のランダム性を制御します。値が高いほど、出力はよりランダムになります。デフォルト = 0。"},"source":{"type":"object","description":"Source configuration for knowledge bases and folders. This is the preferred way to specify search scope. Use this instead of the legacy knowledgeBaseIds/folderIds parameters.\n","properties":{"sharedKnowledgeBaseNodeIds":{"type":"array","items":{"type":"string"},"description":"List of shared knowledge base or folder node IDs (global IDs) to search. Use empty array [] to search all shared documents. Use null to exclude shared documents from search.\n"},"personalKnowledgeBaseNodeIds":{"type":"array","items":{"type":"string"},"description":"List of personal knowledge base or folder node IDs (global IDs) to search. Use empty array [] to search all personal documents. Use null to exclude personal documents from search.\n"},"webSites":{"type":"array","items":{"type":"string"},"description":"List of web sites to search."}}},"knowledgeBaseIds":{"type":"array","items":{"type":"string"},"description":"検索を特定のナレッジベースノード(ドキュメントやフォルダ)IDに限定します。"},"folderIds":{"type":"array","items":{"type":"string"},"description":"検索を特定のドキュメントフォルダーIDに限定します。"}}}}}},"responses":{"200":{"description":"回答が生成されました","content":{"application/json":{"schema":{"type":"object","properties":{"answer":{"type":"object","description":"にアップロードされたドキュメントから生成された回答内容。answerFormatパラメータに従ってフォーマットされています。"},"answerHash":{"type":"string","description":"フィードバックを提供またはキャンセルするための回答を特定するために使用されます。"},"confidence":{"type":"number","description":"AIモデルからの信頼度を示しています。0と1の間の数値として表示されます。"},"effectiveConfidence":{"type":"number","description":"クエリ結果にフィードバックを提供すると、それが自動的にAIモデルをトレーニングします。効果的な信頼度は、これらのユーザーとエージェントのフィードバックで調整されたスコアです。0から1の数値として表示されます。"},"documentId":{"type":"string","description":"回答生成に利用したドキュメントのID。"},"documentName":{"type":"string","description":"回答生成に利用したドキュメントの名前。"},"hashtags":{"type":"array","description":"ドキュメントに付けられたハッシュタグ。"},"pageNo":{"type":"integer","description":"回答生成に利用したドキュメントのページ番号。"},"createdDate":{"type":"string","format":"date","description":"ドキュメントがアップロードされた日付。"},"agentFeedback":{"type":"object","description":"このドキュメントに関するエージェントからのフィードバック(ダッシュボードおよびRESTコールを通じて行われたフィードバック)。"},"userFeedback":{"type":"object","description":"このドキュメントに関するユーザーからのフィードバック。"},"body":{"type":"string","description":"リクエストでreturnPreviewがtrueの場合、ドキュメント検索プレビューのHTMLボディが表示されます。"},"css":{"type":"string","description":"リクエストでreturnPreviewがtrueの場合、ドキュメント検索プレビューのCSSが表示されます。"},"pdfPreview":{"type":"string","description":"リクエストでreturnPdfPreviewがtrueの場合、回答がハイライトされたドキュメントのPDFプレビューへのURLが表示されます。URLは、ダウンロードIP許可リスト設定を使用して制限することができる点に注意してください。"},"folder":{"type":"string","description":"ドキュメントデータベース内のフォルダから見つかった場合、フォルダ名が記載されます。"},"editor":{"type":"array","items":{"type":"string"},"description":"ドキュメントに編集者アクセスを持つエージェントのメールのリスト。"},"viewer":{"type":"array","items":{"type":"string"},"description":"ドキュメントの閲覧アクセス権を持つエージェントのメールのリスト。"},"threadId":{"type":"string","description":"isStatefulがtrueの場合にフォローアップクエスチョンに使用できるUUID。"},"fuQuestion":{"type":"string","description":"isStatefulがtrueの場合、ユーザーへの推奨フォローアップ質問。"},"intent":{"type":"string","description":"クエリの検出されたインテント。"},"clues":{"type":"array","description":"リクエストで手がかりが真の場合、回答を生成するために使用されたソースがここに返されます。"},"citations":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"回答本文中で[1]、[2]などで参照される引用番号。"},"clueId":{"type":"string","description":"一意のソース識別子"},"source":{"type":"string","description":"ソースの種類(ドキュメント、FAQ、WEB)"},"title":{"type":"string","description":"ソースドキュメントまたはFAQのタイトル"},"pageNo":{"type":"integer","description":"ソース文書のページ番号"},"knowledgeBaseId":{"type":"string","description":"ナレッジベースのドキュメントのID"},"faqId":{"type":"string","description":"FAQのID"},"url":{"type":"string","description":"WEBソースのURL"},"text":{"type":"string","description":"原文の抜粋(500文字以内)"}}},"description":"リクエストのincludeCitationsがtrueの場合、構造化された引用情報が返されます。各引用は、回答テキスト内の[number]に対応します。\n"}}}}}},"400":{"description":"不正なリクエスト","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"string","description":"エラーメッセージ"}}}}}},"401":{"description":"無許可","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"string","description":"エラーメッセージ"}}}}}},"429":{"description":"レート制限を超えました。","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"string","description":"レート制限超過"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## 会話を始める(skillを開始する)
> スキルを使用して会話を開始します。注意:このエンドポイントは現在、会話応答ノード、Q\&Aノード、回答生成ノードとしか互換性がありません。アプリには対応していません。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"apps","description":"App related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/start_conversation":{"post":{"tags":["apps"],"operationId":"startConversation","summary":"会話を始める(skillを開始する)","description":"スキルを使用して会話を開始します。注意:このエンドポイントは現在、会話応答ノード、Q&Aノード、回答生成ノードとしか互換性がありません。アプリには対応していません。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"placement":{"type":"string","description":"どのスキルで会話を開始するかを一致させるために使用されます。"}}}}}},"responses":{"200":{"description":"会話を正常に開始しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"conversation":{"type":"object","properties":{"id":{"type":"string","description":"開始したチャットのユニークID。"},"project":{"type":"object","properties":{"nluLanguage":{"type":"string","description":"Allで設定しているiプロジェクトの言語。"}}},"chats":{"type":"object","properties":{"edges":{"type":"array","items":{"type":"object","properties":{"node":{"type":"object","properties":{"id":{"type":"string","description":"チャットID"},"message":{"type":"string","description":"Alliからユーザーに表示されるテキストメッセージ。Draftjs形式です。"},"createdAt":{"type":"number","description":"メッセージが送信されたときのタイムスタンプ。"},"chatOptionInfos":{"type":"array","description":"クリック可能なボタンの内容。、JSONオブジェクトの配列で記載されます。","items":{"type":"object","properties":{"shortenOption":{"type":"string","description":"長さ制限設定が適用された後のテキストの内容"},"longOption":{"type":"string","description":"ボタンのテキスト内容。"},"style":{"type":"object","properties":{"bgColor":{"type":"string"},"bold":{"type":"boolean"},"fontColor":{"type":"string"},"italic":{"type":"boolean"},"lineColor":{"type":"string"},"underline":{"type":"boolean"}}},"meta":{"type":"string"}}}},"isDeleted":{"type":"boolean"}}}}}}}}}}}},"errors":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## 会話ステータスを終了に切り替える
> 管理者側で会話ステータスを終了することができます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"apps","description":"App related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/end_conversation_by_agent":{"post":{"tags":["apps"],"operationId":"endConversationByAgent","summary":"会話ステータスを終了に切り替える","description":"管理者側で会話ステータスを終了することができます。\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The conversation ID to end"}}}}}},"responses":{"200":{"description":"Conversation ended successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"conversation":{"type":"object","properties":{"id":{"type":"string","description":"The conversation ID that was ended"},"completedTime":{"type":"number","description":"The timestamp when the conversation was completed"},"state":{"type":"string","description":"The state of the conversation after ending (e.g., \"END_BY_AGENT\")"},"__typename":{"type":"string","description":"GraphQL typename"}},"description":"The conversation object that was ended"},"__typename":{"type":"string","description":"GraphQL typename for the operation result"}}},"errors":{"type":"object","nullable":true,"description":"Error information if the request fails"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## チャットを送信
> 既存の会話においてユーザーとしてメッセージを送信します。注意: このエンドポイントは現在、メッセージノード、Q\&Aノード、ドキュメントノード、回答生成ノードとのみ互換性があります。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"apps","description":"App related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/send_chat":{"post":{"tags":["apps"],"operationId":"sendChat","summary":"チャットを送信","description":"既存の会話においてユーザーとしてメッセージを送信します。注意: このエンドポイントは現在、メッセージノード、Q&Aノード、ドキュメントノード、回答生成ノードとのみ互換性があります。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["message","conversationId"],"properties":{"message":{"type":"string","description":"会話で送信するメッセージ。null または空の文字列にはできません。"},"conversationId":{"type":"string","description":"メッセージを送信したい会話のユニークID。"}}}}}},"responses":{"200":{"description":"チャットの送信に成功しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"responses":{"type":"array","description":"JSONオブジェクトの配列は、それぞれがメッセージを表しています。最初のメッセージオブジェクトはリクエストのメッセージになります。","items":{"type":"object","properties":{"id":{"type":"string","description":"チャットID"},"message":{"type":"string","description":"Alli がユーザーに表示するテキストメッセージ。キャンペーンのノードに設定されているテキストメッセージはDraftjs形式になります。"},"createdAt":{"type":"number","description":"このメッセージが作成された時刻のタイムスタンプ。"},"chatOptionInfos":{"type":"array","description":"ユーザーに表示されるクリック可能なボタンをそれぞれ表すJSONオブジェクトの配列。","items":{"type":"object","properties":{"shortenOption":{"type":"string","description":"長さ制限の設定が適用された後のテキスト。"},"longOption":{"type":"string","description":"ボタンのテキスト内容。"},"style":{"type":"object","properties":{"bgColor":{"type":"string"},"bold":{"type":"boolean"},"fontColor":{"type":"string"},"italic":{"type":"boolean"},"lineColor":{"type":"string"},"underline":{"type":"boolean"}}},"meta":{"type":"string"}}}},"isDeleted":{"type":"boolean"}}}},"state":{"type":"string","description":"メッセージが送信された後の会話の状態。"}}},"errors":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```