Instill AI provides a set of methods for app management, including listing, updating, and deleting AI Assistant apps. This allows you to effectively manage your AI Assistants within the platform.
#Manage Apps via API
#List Apps
This endpoint returns a list of your AI Assistant apps, including their metadata.
#Example Response
A successful response will return a JSON object containing a list of your apps:
{ "apps": [ { "appId": "your-app-id", "description": "A brief description of your app", "createTime": "2024-10-07T12:34:56Z", "updateTime": "2024-10-07T12:34:56Z", "ownerUid": "your-namespace-uid", "tags": ["AI", "Assistant"], "appType": "APP_TYPE_AI_ASSISTANT", "appUid": "generated-app-uid", "creatorUid": "your-user-uid" }, { "appId": "another-app-id", "description": "Another AI Assistant", "createTime": "2024-10-08T09:21:34Z", "updateTime": "2024-10-08T09:21:34Z", "ownerUid": "your-namespace-uid", "tags": ["AI", "Chatbot"], "appType": "APP_TYPE_AI_ASSISTANT", "appUid": "another-generated-app-uid", "creatorUid": "your-user-uid" } ]}
#Update App
This endpoint enables you to update an AI Assistant app's details, such as its description and tags.
#Body Parameters
newAppId
(string, optional): The new app ID. Must follow the kebab case format (lowercase letters and hyphens). If not provided, the app ID will not be updated.newDescription
(string, optional): The new description for the app. If set to empty, the description will be cleared.newTags
(array of strings, optional): The new tags for the app. If set to empty, the tags will be cleared.
#Example Response
A successful response will return the updated app details:
{ "app": { "appId": "your-app-id", "description": "Updated description of your app", "createTime": "2024-10-01T12:34:56Z", "updateTime": "2024-10-09T08:22:10Z", "ownerUid": "your-namespace-uid", "tags": ["updated_tag1", "updated_tag2"], "appType": "APP_TYPE_AI_ASSISTANT", "appUid": "generated-app-uid", "creatorUid": "your-user-uid" }}
#Delete App
This endpoint enables you to delete an AI Assistant app.
Please note that once an app is deleted, all related status and settings will be permanently removed.
A successful response will return an empty JSON object, indicating that the app has been deleted.
The NAMESPACE_ID
and APP_ID
path parameters must be replaced with the app
owner's ID and the app ID, respectively.
#Manage Apps via Console
#List Apps
To list the AI Assistant apps under a namespace in Instill Console, follow these steps:
- Launch Instill Console on Instill Cloud.
- Navigate to the Applications page using the navigation bar.
Your AI Assistants will automatically appear on the page.
#Update App
To update an AI Assistant app details in Instill Console, follow these steps:
- Launch Instill Console on Instill Cloud.
- Navigate to the Applications page using the navigation bar.
- Locate the AI Assistant you wish to update.
- Click the
...
(ellipsis) button in the bottom-right corner of the AI Assistant card. - Select
Edit Info
from the dropdown menu. - Update the app's description, tags, or other details as needed.
- Save your changes.
#Delete App
Please note that once an AI Assistant is deleted, all related status and settings will be permanently removed.
To delete an AI Assistant app in Instill Console, follow these steps:
- Launch Instill Console on Instill Cloud.
- Navigate to the Applications page using the navigation bar.
- Locate the AI Assistant you wish to delete.
- Click the
...
(ellipsis) button in the bottom-right corner of the AI Assistant card. - Select
Delete
from the dropdown menu. - Confirm the deletion when prompted.