Create project

Create a project to group deployments and applications under a workspace-scoped slug.

The slug you provide is the stable, caller-defined handle used to reference this project in subsequent operations (get, update, delete). It must be unique within your workspace.

Important: The slug cannot collide with an existing project in your workspace. A duplicate slug returns a 409 conflict.

Required Permissions

Your root key must have the following permission:

• project.*.create_project (to create projects in your workspace)

POST /v2/projects.createProject

Python (SDK)

Python

from unkey.py import Unkey


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.projects.create_project(name="Payments Service", slug="payments-service")

    # Handle response
    print(res)

200

{
  "data": {
    "id": "proj_1234abcd"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

Authorizations

Authorization · string · header · required

Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs. To authenticate, include the token in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key. Security best practices:

• Keep root keys secure and never expose them in client-side code
• Use different root keys for different environments
• Rotate keys periodically, especially after team member departures
• Create keys with minimal necessary permissions following least privilege principle
• Monitor key usage with audit logs.

Body

application/json

name · string · required

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

Required string length: 1 - 256

Example:

"Payments Service"

slug · string · required

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

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

Response

200

application/json

Project created successfully. The response contains the project id used to reference it in subsequent operations.

meta · object · required

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

data · object · required

Show child attributes