Create App | Documentation

This page shows you how to create a new AI Assistant app using on the Instill Cloud platform. An AI Assistant app allows you to build conversational interfaces powered by AI, enabling real-time interactions with users.

This is the first step before you can manage conversations and messages within your AI Assistant.

#Create App via API

cURL

export INSTILL_API_TOKEN=********
curl -X POST 'https://api.instill.tech/v1alpha/namespaces/NAMESPACE_ID/apps' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $INSTILL_API_TOKEN" \
--data '{
  "id": "your-app-id",
  "description": "A brief description of your app",
  "tags": ["AI", "Assistant"]
}'

Note that the NAMESPACE_ID path parameter must be replaced by the App owner's ID (namespace). The new name should be lowercase, without any space or special character except for hyphens. It cannot start with a number or hyphen, and should be less than 32 characters.

#Body Parameters

id (string, required): The unique identifier for your app. Must follow the formatting rules mentioned above.
description (string, optional): A brief description of your app.
tags (array of strings, optional): A list of tags associated with your app for easier categorization and searchability.

#Example Response

A successful response will return a JSON object containing the details of the newly created app.

{
  "app": {
    "appId": "your-app-id",
    "description": "A brief description of your app",
    "createTime": "2024-10-07T12:34:56Z",
    "updateTime": "2024-10-08T12:34:56Z",
    "ownerUid": "your-namespace-uid",
    "tags": ["AI", "Assistant"],
    "appType": "APP_TYPE_AI_ASSISTANT",
    "appUid": "generated-app-uid",
    "creatorUid": "your-user-uid"
  }
}

#Output Description

app: An object containing the details of the created app.
- appId (string): The ID of your app.
- description (string): The description of your app.
- createTime (string): The timestamp when the app was created.
- updateTime (string): The timestamp when the app was last updated.
- ownerUid (string): The unique identifier of the namespace that owns the app.
- tags (array of strings): The tags associated with your app.
- appType (string): The type of the app. For AI Assistant apps, this will be APP_TYPE_AI_ASSISTANT.
- appUid (string): The unique identifier generated by the system for your app.
- creatorUid (string): The unique identifier of the user who created the app.

#Create App via Console

To create a new AI Assistant from Instill Console, follow these steps:

Launch Instill Console on Instill Cloud.
Navigate to the Applications page using the navigation bar.
Click the + Create App button.
Select the Owner (namespace).
Enter the name for your AI Assistant.
(Optional) Enter the Description & Tags for your AI Assistant.
Click the Create button.