Skip to main content
POST
/
projects
Create a new project
curl --request POST \
  --url https://api.engagefabric.com/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Awesome App",
  "slug": "my-awesome-app",
  "tenantId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "Production environment for My Awesome App",
  "environment": "DEVELOPMENT",
  "config": {
    "xp": {
      "levelCurve": "exponential",
      "baseXP": 100,
      "growthRate": 1.5,
      "maxXPPerDay": 10000
    },
    "currencies": [
      {
        "id": "coins",
        "name": "Coins",
        "icon": "🪙",
        "maxPerDay": 1000
      }
    ],
    "lives": {
      "max": 5,
      "regenRate": 30,
      "regenAmount": 1
    }
  },
  "metadata": {
    "version": "1.0.0",
    "buildNumber": 42
  }
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "tenantId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Awesome App",
  "slug": "my-awesome-app",
  "environment": "PRODUCTION",
  "status": "ACTIVE",
  "isActive": true,
  "tier": "FREE",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z",
  "description": "Production environment for My Awesome App",
  "config": {
    "xp": {
      "levelCurve": "exponential",
      "baseXP": 100
    },
    "currencies": [
      {
        "id": "coins",
        "name": "Coins"
      }
    ]
  },
  "metadata": {
    "version": "1.0.0"
  },
  "deletedAt": null
}

Authorizations

​
Authorization
string
header
required

JWT token for admin console authentication

Body

application/json
​
name
string
required

Project name

Required string length: 2 - 255
Example:

"My Awesome App"

​
slug
string
required

Project slug (URL-friendly identifier, lowercase alphanumeric and hyphens)

Required string length: 2 - 100
Example:

"my-awesome-app"

​
tenantId
string

Tenant ID (automatically set from authenticated user)

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
description
string

Project description

Example:

"Production environment for My Awesome App"

​
environment
enum<string>
default:DEVELOPMENT

Environment type

Available options:
DEVELOPMENT,
STAGING,
PRODUCTION
​
config
object

Game configuration (XP, currencies, lives, etc.)

Example:
{
  "xp": {
    "levelCurve": "exponential",
    "baseXP": 100,
    "growthRate": 1.5,
    "maxXPPerDay": 10000
  },
  "currencies": [
    {
      "id": "coins",
      "name": "Coins",
      "icon": "🪙",
      "maxPerDay": 1000
    }
  ],
  "lives": {
    "max": 5,
    "regenRate": 30,
    "regenAmount": 1
  }
}
​
metadata
object

Additional metadata (JSON object)

Example:
{ "version": "1.0.0", "buildNumber": 42 }

Response

Project created successfully

​
id
string
required

Unique project identifier

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
tenantId
string
required

Tenant ID that owns this project

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

Project name

Example:

"My Awesome App"

​
slug
string
required

URL-friendly slug

Example:

"my-awesome-app"

​
environment
enum<string>
required

Environment type

Available options:
DEVELOPMENT,
STAGING,
PRODUCTION
Example:

"PRODUCTION"

​
status
enum<string>
required

Project status

Available options:
ACTIVE,
PAUSED,
ARCHIVED
Example:

"ACTIVE"

​
isActive
boolean
required

Whether the project is active (status === ACTIVE)

Example:

true

​
tier
enum<string>
required

Rate limiting tier

Available options:
FREE,
STARTER,
PROFESSIONAL,
BUSINESS,
ENTERPRISE
Example:

"FREE"

​
createdAt
string<date-time>
required

Creation timestamp

Example:

"2025-01-15T10:30:00Z"

​
updatedAt
string<date-time>
required

Last update timestamp

Example:

"2025-01-15T10:30:00Z"

​
description
object

Project description

Example:

"Production environment for My Awesome App"

​
config
object

Game configuration (XP, currencies, lives, etc.)

Example:
{
  "xp": {
    "levelCurve": "exponential",
    "baseXP": 100
  },
  "currencies": [{ "id": "coins", "name": "Coins" }]
}
​
metadata
object

Additional metadata

Example:
{ "version": "1.0.0" }
​
deletedAt
object

Soft deletion timestamp

Example:

null

​
_count
object

Related entity counts