Creating apps

Applications (apps) are installable modules with their own UI. Register them in Admin → Applications. After adding alias, base URL, and icon, the app appears in the portal sidebar. Only one endpoint is required.

Required endpoint

GET {base_url}/metadata — Return JSON:

name name (required): display name
description: description: short description
version, developer, capabilities, status: version, developer, capabilities, status: optional

Example response:

{
  "name": "My App",
  "description": "Document processing",
  "capabilities": ["upload", "export"],
  "status": "active"
}

The portal calls /metadata to show the name and check status (healthy/unhealthy).

Registration

Deploy a server that exposes GET {base_url}/metadata.
Admin → Applications → Add: alias, base_url, icon (e.g. FileText, Database, Bot), is_active, display_order.

Optional: chat integration

If the app also participates in chat, implement POST /ask and GET /data per the Agent contract. Otherwise, only /metadata is required to register an application.

Next:Creating assistants →