Skip to main content
POST
Create a new mini app
Creating an app makes the acting user its owner. The editor list starts empty, allowing everyone with app edit permission to edit. The user must have mini-apps:write. Bare API keys receive 403, including keys created by an administrator. See Mini-app editing access for invitations, ownership transfer, and the difference between viewing and editing.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
Required string length: 1 - 120
description
string
Maximum string length: 2000
icon
enum<string>
Available options:
ChartBar,
ChartBarHorizontal,
ChartLine,
ChartLineUp,
ChartPie,
ChartDonut,
ChartScatter,
ChartPolar,
TrendUp,
TrendDown,
Graph,
Table,
ListBullets,
Kanban,
Funnel,
Gauge,
Pulse,
Percent,
Calculator,
Target,
Crosshair,
Timer,
Clock,
CalendarBlank,
Users,
UsersThree,
User,
UserCircle,
IdentificationBadge,
Headset,
Handshake,
Chat,
ChatsTeardrop,
Envelope,
Phone,
Globe,
Megaphone,
PaperPlaneTilt,
Bell,
Star,
Heart,
Smiley,
ThumbsUp,
Warning,
ShieldCheck,
Trophy,
Medal,
Flag,
Fire,
Rocket,
Lightning,
Sparkle,
Robot,
Brain,
MagicWand,
Atom,
Lightbulb,
Money,
CurrencyDollar,
Coins,
CreditCard,
Receipt,
ShoppingCart,
Package,
Truck,
Storefront,
Buildings,
MapPin,
Tag,
Bookmark,
Ticket,
Database,
Stack,
Cube,
Wrench,
Gear,
Flask,
FileText,
ClipboardText,
Notebook,
SquaresFour,
TreeStructure,
Eye,
Binoculars,
Compass,
Scales,
Question,
Info

Response

Default Response

app_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$