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

# Create a project

`POST /projects`

## Request

- Base URL: `https://api.epovest.com/v1`
- URL: `https://api.epovest.com/v1/projects`
- Auth: HTTP bearer

Creates a folder. The canon carried at creation is recorded as version 1. When the name is
already taken (case, accents and spacing do not make two different names), `409
project_exists` carries the existing project, so reuse its id. Manager or above.

## Request body

- object: The canon, field by field. A sent field replaces the current wording, an empty string or `null` clears it, and an omitted field is kept as is.
  - `name` string, required: The name of the folder, unique per account.
  - `canon_one_liner` string, nullable
  - `canon_short` string, nullable
  - `canon_long` string, nullable
  - `canon_category` string, nullable
  - `canon_language` string, nullable
  - `canon_perks` string[], nullable
  - `canon_website` string, nullable
  - `canon_legal_name` string, nullable
  - `canon_address` string, nullable
  - `canon_phone` string, nullable
  - `canon_whatsapp` string, nullable
  - `canon_email` string, nullable

## Response `201`

The project.

- ProjectEnvelope
  - `project` Project, required
    - `id` string, uuid, required
    - `name` string, required
    - `canon` Canon, required: The brand identity sheet: the text every publication reuses as is, so all mentions tell the same entity. It lives in ONE language per project, its canonical language, and the facts are language-NEUTRAL and identical everywhere.
      - `one_liner` string, nullable, required
      - `short` string, nullable, required
      - `long` string, nullable, required
      - `category` string, nullable, required
      - `language` string, nullable, required: The canonical language, a short code like `en` or `pt-br`. Null when never declared.
      - `perks` string[], required: The ordered list of distinctive claims, written in the canonical language, meant to be hammered so the engines bring them up on their own: facts that hold and can be corroborated.
      - `website` string, nullable, required: The canonical address that identifies the entity, ONE URL only. A bare domain completes to https, and a trailing slash is dropped.
      - `legal_name` string, nullable, required: The registered name of the company that operates the brand, with its jurisdiction when it is stated: the name the AIs cross-read to anchor the entity.
      - `address` string, nullable, required
      - `phone` string, nullable, required
      - `whatsapp` string, nullable, required
      - `email` string, nullable, required
    - `canon_version` integer, nullable, required
    - `link_targets` string[], required: The free addresses of the brand set on the project, the ones read by `GET /projects/{id}/link-targets`.
    - `archived` boolean, required
    - `tracker_count` integer, required: How many trackers are still filed under it.
    - `created_at` string, date-time, required

## Other responses

- `401`: `unauthenticated`: missing, unknown or revoked key.
- `403`: `insufficient_scope`: the credential may not do this, either because the key lacks the scope, or, on a one-click connection, because the person lacks the role the action needs (manager, or owner to start, pause and top up). On that path, read it as "this person may not do this" and tell them which role the action needs.
- `409`: `project_exists`: the answer carries the existing project as `project`.
- `422`: `invalid_name` or `invalid_canon`: the message names what it refuses.
- `429`: `rate_limited`: 120 requests per minute per credential, sliding window. Retry after `Retry-After` seconds.

---

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