Sign in

v66

OpenAPI 3.1.0raw.githubusercontent.com2026-08-0174265626.3 KB
apps

Create app

Create an app within a project. The app is created with default production and preview environments.

The slug you provide is the stable, caller-defined handle used to reference this app. It must be unique within the project.

Important: The slug cannot collide with an existing app in the same project. A duplicate slug returns a 409 conflict.

Required Permissions

Your root key must have one of the following permissions:

  • project.*.create_app (to create apps in any project)
  • project.<project_id>.create_app (to create apps in a specific project)
post/v2/apps.createApp

Request body

projectstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

namestring required

Human-readable name for this app. Use a descriptive name like 'Payments API' to identify its purpose.

slugstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Example request

{
  "project": "proj_1234abcd",
  "name": "Payments API",
  "slug": "proj_1234abcd"
}

Response

App created successfully. The response contains the app id used to reference it in subsequent operations.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "appId": "app_1234abcd"
  }
}