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
  }
}
'

import requests

url = "https://api.engagefabric.com/projects"

payload = {
    "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
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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}
  })
};

fetch('https://api.engagefabric.com/projects', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.engagefabric.com/projects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.engagefabric.com/projects"

	payload := strings.NewReader("{\n  \"name\": \"My Awesome App\",\n  \"slug\": \"my-awesome-app\",\n  \"tenantId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"description\": \"Production environment for My Awesome App\",\n  \"environment\": \"DEVELOPMENT\",\n  \"config\": {\n    \"xp\": {\n      \"levelCurve\": \"exponential\",\n      \"baseXP\": 100,\n      \"growthRate\": 1.5,\n      \"maxXPPerDay\": 10000\n    },\n    \"currencies\": [\n      {\n        \"id\": \"coins\",\n        \"name\": \"Coins\",\n        \"icon\": \"🪙\",\n        \"maxPerDay\": 1000\n      }\n    ],\n    \"lives\": {\n      \"max\": 5,\n      \"regenRate\": 30,\n      \"regenAmount\": 1\n    }\n  },\n  \"metadata\": {\n    \"version\": \"1.0.0\",\n    \"buildNumber\": 42\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.engagefabric.com/projects")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Awesome App\",\n  \"slug\": \"my-awesome-app\",\n  \"tenantId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"description\": \"Production environment for My Awesome App\",\n  \"environment\": \"DEVELOPMENT\",\n  \"config\": {\n    \"xp\": {\n      \"levelCurve\": \"exponential\",\n      \"baseXP\": 100,\n      \"growthRate\": 1.5,\n      \"maxXPPerDay\": 10000\n    },\n    \"currencies\": [\n      {\n        \"id\": \"coins\",\n        \"name\": \"Coins\",\n        \"icon\": \"🪙\",\n        \"maxPerDay\": 1000\n      }\n    ],\n    \"lives\": {\n      \"max\": 5,\n      \"regenRate\": 30,\n      \"regenAmount\": 1\n    }\n  },\n  \"metadata\": {\n    \"version\": \"1.0.0\",\n    \"buildNumber\": 42\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.engagefabric.com/projects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Awesome App\",\n  \"slug\": \"my-awesome-app\",\n  \"tenantId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"description\": \"Production environment for My Awesome App\",\n  \"environment\": \"DEVELOPMENT\",\n  \"config\": {\n    \"xp\": {\n      \"levelCurve\": \"exponential\",\n      \"baseXP\": 100,\n      \"growthRate\": 1.5,\n      \"maxXPPerDay\": 10000\n    },\n    \"currencies\": [\n      {\n        \"id\": \"coins\",\n        \"name\": \"Coins\",\n        \"icon\": \"🪙\",\n        \"maxPerDay\": 1000\n      }\n    ],\n    \"lives\": {\n      \"max\": 5,\n      \"regenRate\": 30,\n      \"regenAmount\": 1\n    }\n  },\n  \"metadata\": {\n    \"version\": \"1.0.0\",\n    \"buildNumber\": 42\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "_count": {
    "players": 150,
    "apiKeys": 3
  }
}

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
  }
}
'

import requests

url = "https://api.engagefabric.com/projects"

payload = {
    "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
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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}
  })
};

fetch('https://api.engagefabric.com/projects', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.engagefabric.com/projects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.engagefabric.com/projects"

	payload := strings.NewReader("{\n  \"name\": \"My Awesome App\",\n  \"slug\": \"my-awesome-app\",\n  \"tenantId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"description\": \"Production environment for My Awesome App\",\n  \"environment\": \"DEVELOPMENT\",\n  \"config\": {\n    \"xp\": {\n      \"levelCurve\": \"exponential\",\n      \"baseXP\": 100,\n      \"growthRate\": 1.5,\n      \"maxXPPerDay\": 10000\n    },\n    \"currencies\": [\n      {\n        \"id\": \"coins\",\n        \"name\": \"Coins\",\n        \"icon\": \"🪙\",\n        \"maxPerDay\": 1000\n      }\n    ],\n    \"lives\": {\n      \"max\": 5,\n      \"regenRate\": 30,\n      \"regenAmount\": 1\n    }\n  },\n  \"metadata\": {\n    \"version\": \"1.0.0\",\n    \"buildNumber\": 42\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.engagefabric.com/projects")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Awesome App\",\n  \"slug\": \"my-awesome-app\",\n  \"tenantId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"description\": \"Production environment for My Awesome App\",\n  \"environment\": \"DEVELOPMENT\",\n  \"config\": {\n    \"xp\": {\n      \"levelCurve\": \"exponential\",\n      \"baseXP\": 100,\n      \"growthRate\": 1.5,\n      \"maxXPPerDay\": 10000\n    },\n    \"currencies\": [\n      {\n        \"id\": \"coins\",\n        \"name\": \"Coins\",\n        \"icon\": \"🪙\",\n        \"maxPerDay\": 1000\n      }\n    ],\n    \"lives\": {\n      \"max\": 5,\n      \"regenRate\": 30,\n      \"regenAmount\": 1\n    }\n  },\n  \"metadata\": {\n    \"version\": \"1.0.0\",\n    \"buildNumber\": 42\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.engagefabric.com/projects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Awesome App\",\n  \"slug\": \"my-awesome-app\",\n  \"tenantId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"description\": \"Production environment for My Awesome App\",\n  \"environment\": \"DEVELOPMENT\",\n  \"config\": {\n    \"xp\": {\n      \"levelCurve\": \"exponential\",\n      \"baseXP\": 100,\n      \"growthRate\": 1.5,\n      \"maxXPPerDay\": 10000\n    },\n    \"currencies\": [\n      {\n        \"id\": \"coins\",\n        \"name\": \"Coins\",\n        \"icon\": \"🪙\",\n        \"maxPerDay\": 1000\n      }\n    ],\n    \"lives\": {\n      \"max\": 5,\n      \"regenRate\": 30,\n      \"regenAmount\": 1\n    }\n  },\n  \"metadata\": {\n    \"version\": \"1.0.0\",\n    \"buildNumber\": 42\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "_count": {
    "players": 150,
    "apiKeys": 3
  }
}

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

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

Show child attributes

Get all projects for the user's tenant Get a project by ID

Getting Started

Guides

Core Concepts

API Reference

Endpoints

SDKs

Resources

Create a new project

Authorizations

Body

Response