> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a mini-app

> Create an app owned by the acting teammate. Learn the required permissions and why bare API keys cannot create mini-apps.

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.

`tags` is optional: up to 10, each up to 32 characters. Tags match
case-insensitively against your other apps’ tags and take their spelling, so
`billing` joins an existing `Billing`; repeats are dropped. [List tags](https://docs.open.cx/api-reference/mini-apps/tags.md)
shows the spellings in use.

See [Mini-app editing access](https://docs.open.cx/build-agents/mini-apps.md) for invitations, ownership
transfer, and the difference between viewing and editing.


## OpenAPI

````yaml post /mini-apps
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /mini-apps:
    post:
      summary: Create a new mini app
      description: >-
        Requires an identified user with mini-apps:write. The creator becomes
        the owner. An empty editor list allows everyone with app edit
        permission. Bare API keys cannot create apps.
      operationId: createMiniApp
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMiniAppDto'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMiniAppResponseDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    CreateMiniAppDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/CreateMiniAppDtoInput'
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
        description:
          type: string
          maxLength: 2000
        icon:
          $ref: '#/components/schemas/MiniAppIcon'
      required:
        - name
    CreateMiniAppResponseDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/CreateMiniAppResponseDto'
      type: object
      properties:
        app_id:
          type: string
          format: uuid
          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)$
      required:
        - app_id
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
    MiniAppIcon:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/MiniAppIcon'
      type: string
      enum:
        - 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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.