---
title: "Create an app instance"
method: POST
path: "/v1/app-instances"
tags: ["app-instances"]
---

# Create an app instance

`POST /v1/app-instances`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/app-instances`
- Auth: HTTP bearer

Configure an app for the workspace with an `appKey`, `name`, and optional `config` and `nodeId`. `appKey` must match one of the apps offered by the store; list the available keys first with GET /v1/apps/catalog.

**Notes.**
- The 201 body is the row as written, not re-read from the database, so columns the create does not set (for example `lastSnapshotAt`) are absent rather than null. `GET` returns every column.

## Request body

- object
  - `appKey` string, required: A key from `GET /v1/apps/catalog`. An unknown key is refused (422 `unknown_app`).
  - `name` string, required
  - `config` union: The app's settings: a JSON object, or the same as a JSON string. Default `{}`.
    - object
    - string
  - `nodeId` string, nullable: Home location. Default: the caller's own location.

## Response `201`

Success.

- object
  - `data` object, required
    - `id` string, required: App instance id.
    - `spaceId` string, required: Workspace id.
    - `appKey` string, required: The app type: a key from `GET /v1/apps/catalog` (`clock`, `weather`, `rss`, …).
    - `name` string, required
    - `config` unknown, required
    - `nodeId` string, nullable: Home location, when one was set or derived.
    - `lastSnapshotKey` string, nullable
    - `lastSnapshotAt` string, nullable: ISO-8601 timestamp (UTC).
    - `importSourceId` string, nullable
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `deletedAt` string, nullable, required: ISO-8601 timestamp (UTC).

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `422`: Missing `appKey`/`name`, invalid JSON config, unknown app (`unknown_app`), or a location outside this workspace.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)