---
title: "Create Project"
method: POST
path: "/project"
tags: ["projects"]
---

# Create Project

`POST /project`

## Request

- Base URL: `https://api.faable.com`
- URL: `https://api.faable.com/project`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://faable.auth.faable.link/authorize`, token URL `https://faable.auth.faable.link/oauth/token`)
  - HTTP bearer
  - OAuth 2 (client credentials, token URL `https://faable.auth.faable.link/oauth/token`)
  - HTTP bearer
  - HTTP basic
  - API key in query parameter `apikey`

Create Project

## Request body

- object
  - `name` string, required
  - `description` string
  - `collaborators` string[]
  - `product_intent` union
    - 'deploy'
    - 'auth'
    - 'undecided'

## Response `201`

Project

- object: Project
  - `id` string, required: Project ID
  - `name` string, required
  - `description` string, required
  - `slug` string, required
  - `team` string, required
  - `user_id` string
  - `collaborators` string[], required
  - `members` object[]
    - `user_id` string, required
    - `role` string, required
  - `product_intent` union
    - 'deploy'
    - 'auth'
    - 'undecided'
  - `owner_suspended` boolean
  - `owner_email` string
  - `organization` string, nullable
  - `createdAt` string, required: Project creation date
  - `updatedAt` string: Project updated date

## Other responses

- `400`: `already_exists` — A resource with the same unique field already exists. `details.fields` names the field. `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field. `team_required` — The operation needs a project: send it in the `x-faable-project` header (`project_<id>`). `invalid_project_description` — The project description is not acceptable (a link, or over the length limit). `message` says why.
- `401`: `unauthorized` — The request carries no valid credentials. `invalid_token` — The bearer token is missing, malformed or expired.
- `402`: `project_plan_limited` — The Free plan project cap is reached. Upgrade to create more.
- `403`: `user_suspended` — The account is suspended. Contact support@faable.com. `forbidden` — The credentials are valid but do not allow this operation.
- `429`: `project_rate_limited` — A new account may only create a few projects in its first hours. It opens with time, or with a plan. `too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header.
- `500`: `internal_error` — Unexpected server error. Retry later; the request id is logged.
- `503`: `database_unavailable` — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.

---

[API](https://skmtc.dev/faable/apis/faablecloud-api.md) · [All operations](https://skmtc.dev/faable/apis/faablecloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faable/apis/faablecloud-api/revisions/e2fc93da3c49?raw)