Alli LLM App Market API
This document provides detailed information about the REST API's available for the Alli LLM App Market. We currently provide APIs to get and run LLM Apps, and more APIs will be added in the future.
Last updated
This document provides detailed information about the REST API's available for the Alli LLM App Market. We currently provide APIs to get and run LLM Apps, and more APIs will be added in the future.
Last updated
Kindly be advised that the utilization of the Alli App Market is not universally accessible to all clients. Should you express interest in utilizing our App Market, we recommend that you reach out to your designated account manager for further information and guidance.
Please provide your API key in the request header API-KEY
. Your API key can be found in your dashboard Settings menu, under the General tab.
Please read the error message you get if you don't get the response that you expected. For example, if you don't use the right HTTP method for the API, you'll get this type of error as response:
If you don't include the inputs when running the LLM App for example, you'll get this type of error as a response:
GET
https://backend.alli.ai/webapi/apps
App list search API allows you to see all single action and conversational apps within your project
Name | Type | Description |
---|---|---|
Please replace YOUR_REST_API_KEY with your one in the example below. Please see getting-api-key section.
POST
https://backend.alli.ai/webapi/apps/:app_id/run
Run LLM App API allows you to run the desired skill/conversational or single-action app.
Please replace YOUR_REST_API_KEY with your one in the example below. Please see getting-api-key section.
Currently, Skills that require user interaction in the middle of the app execution (e.g., asking the user to make a selection, enter a message, etc.) are not supported by the LLM App API. (However, launching an LLM node after uploading a document is an exception, as shown in the example below).
Please replace YOUR_REST_API_KEY with your one in the example below. Please see getting-api-key section.
If you did not receive the expected response, please check the error message
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Status Code | Error Code | Name | Message | Description |
---|---|---|---|---|
published
boolean
Choose whether to show only the apps that are published or not.
True
will show published apps.
False
will show drafts only.
Default shows all apps.
user
string
User ID (Optional; if not provided, all apps will be fetched)
id
string
Specify an app ID. (Optional; if not provided, all apps will be fetched. Can be multiple id's, eg. id=abc&id=bcd)
API-KEY*
string
Your Rest API key can be found in your dashboard Settings menu, under the General tab.
API-KEY*
string
Your Rest API key can be found in your dashboard Settings menu, under the General tab.
inputs
json
Input for use in a single action or conversational/skill. Single action: Only the variable inputs used in the single action app are available.
Conversational/skill : Currently, only variables set as user variables can be used.
mode
string
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.
500
7000
API Error
Something went wrong
The default message for API processing failures, received in the event of an unclassified error.
403
7001
Invalid API key
API-KEY is not valid
Number of cases where the API Key requested in the header is invalid
403
7002
Invalid JSON
Cannot decode the requested JSON body
Received if the requested JSON file is invalid and cannot be decoded
400
7003
Invalid parameter
Requested parameters are not valid. 'text' is empty.
Received if the requested parameter is invalid (e.g., requesting a reference with empty text)
403
7004
Payment error
Billing error
Received general errors with payments (e.g., payment is past due, etc.)
405
-
Wrong HTTP Method
-
Received if an invalid HTTP method was used