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

# Create Work Project

`POST /work/projects`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/work/projects`
- Auth: HTTP bearer

Create one project in one channel.

``channel`` is the channel NAME. The channel is resolved and authorized
exactly the way a send is, so a caller who may not post in a room may not
attach durable state to it: ``403``. The project id, the creator and the
room event come from the server; a body asserting them is refused by name.

## Headers

- `Idempotency-Key` string, nullable: Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry.
- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- WorkProjectCreateRequest: One project a person is creating, in one channel. `channel` is the channel NAME — a project belongs to a room, and the room decides who may create one. The identifier is minted server-side and the creator comes from the session; `SERVER_OWNED_MESSAGE_FIELDS` refuses a body that tries to assert either, by name rather than by `extra="forbid"`.
  - `channel` string, required
  - `name` string, required
  - `description` string, nullable
  - `status` 'active' | 'paused' | 'completed' | 'archived'

## Response `201`

Successful Response

- ApiResponseWorkProjectWriteResult
  - `data` WorkProjectWriteResult, required: The result of one project write, with its idempotent-replay marker.
    - `project` WorkProject: One project: a named unit of work attached to a channel.
      - `id` string, nullable: Project id, minted server-side
      - `name` string, nullable: Project name
      - `description` string, nullable: Project description; null when cleared
      - `status` string, nullable: `active`, `paused`, `completed` or `archived`
      - `channel` string, nullable: Channel the project belongs to
      - `createdBy` string, nullable: Ownership identity of whoever created it
    - `duplicate` boolean, nullable: True when an Idempotency-Key replay returned the original result rather than writing again
    - `compatibilityEventId` string, nullable: Id of the room event the write appended
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)