Create an app – POST /v1/apps | Permute Factory Docs

POST/v1/apps

betaapiKeyworkspace

When to use

Create an app with a hosted starter page.

For agents

Use a stable key when retrying creation. Poll get until deployment.status is live, then open deployment.url. Visitors need Permute sign-in and app read permission.

Example

typescript

import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);

const result = await client.apps.create({
  "name": "Operations portal",
  "key": "operations-portal",
  "description": "Internal operations portal"
});

Request body

json

{
  "name": "Operations portal",
  "key": "operations-portal",
  "description": "Internal operations portal"
}

Response

json

{
  "data": {
    "id": "appl_abcdefghijklmnopqrstuvwx",
    "workspaceId": "wksp_finance123",
    "name": "Operations portal",
    "description": "Internal operations portal",
    "deployment": {
      "status": "deploying",
      "url": "https://operations-portal-abcdefghijklmnopqrstuvwx.permute.site",
      "revisionId": "rvsn_draft123",
      "error": null
    },
    "draft": {
      "revisionId": "rvsn_draft123",
      "sequence": 1
    },
    "createdAt": "2026-09-30T12:00:00.000Z",
    "updatedAt": "2026-09-30T12:00:00.000Z"
  }
}