DevelopersHow to connect an assistantKeys
Reference/Projects/Create

Create a project

POSThttps://api.getwerk.ai/api/v1/projects

Creates a project owned by the key's person.

Its steps come from a template, Werk's Simple one when none is named, or are given whole. A photo uploaded first can be made its photo.

Authorization

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Headers

Werk-Localestring

The language tag Werk writes the answer's own words in, such as step names and history lines, matched to a language it serves; a card's text stays as written. At a project's paths, the reads of its cards and steps, of a card, its update photos, a file and its reminders, and of follow and reminder invitations, and a document's read-now and consent, take the language of the person's chat with Werk in that project first, while it has one. Without either, the language Werk uses with the person the key or the connection acts for.

Body

clientRequestIdstring, uuidRequired

An id the caller makes for this request. Sent again with the same request, it returns the first answer and changes nothing twice; sent with a different request, it is refused.

photoAssetIdstring, uuid

A photo uploaded first with POST /assets, made the project's photo.

namestringRequired

The project's name.

From 1 to 60 characters
templateIdenum or string, uuid

The step template the project's steps come from; left out, Werk's own Simple template.

Allowed valuessimpletechnicianssoftwarehome
stepsarray of objects

The project's steps, in order; given, they are taken instead of the template's.

From 2 to 100 items
Show properties of stepsHide properties of steps
idstringRequired

The step's id: an existing step's id keeps that step and its cards, a new id adds a step.

Up to 64 characters
labelobjectRequired

The step's name: one of Werk's own words, or a name as written.

Show properties of labelHide properties of label

One of 2 shapes, told apart by kind:

kindlocale_key
kindenumRequired

locale_key for one of Werk's own words, written in each reader's language; text for a name as written.

Allowed valueslocale_key
keyenumRequired

Which of Werk's own words names the step.

Allowed valuesproject_steps.steps.openproject_steps.steps.in_progressproject_steps.steps.waiting_partsproject_steps.steps.doneproject_steps.steps.paidproject_steps.steps.in_review
kindtext
kindenumRequired

locale_key for one of Werk's own words, written in each reader's language; text for a name as written.

Allowed valuestext
textstringRequired

The step's name, as written.

From 1 to 60 characters
bucketenumRequired

The kind of step: the first step must be new, in_progress or waiting, and the last resolved or closed.

Allowed valuesnewin_progresswaitingresolvedclosed

Response

201 The new project and its steps.

conversationobject

The new project, as the key's person sees it in their list.

Show properties of conversationHide properties of conversation
projectIdstring, uuid

The project's id.

colorenum

The color the key's person sees the project in.

Allowed valuespinktangerineyellowgreenturquoiseskyblueviolet
highlightedboolean

True when the key's person marked the project to stand out in their list.

appearanceRevisioninteger

Grows with each change to the key's person's color or mark for the project.

At least 1
idstring

The id Werk's apps use for the key's person's view of this project; the API's paths take projectId.

listPositioninteger or null

The key's person's own place for the project in their list, or null while they never ordered it.

peopleVersioninteger

The version of the project's people, which changes whenever its people do.

At least 1
statusLinestring or null

One line Werk writes from the project's cards on how the project is going, or null before there is one.

statusLineAtstring, date-time or null

When that line was written.

archivedboolean

True when the project is archived.

personalboolean

True for the key's person's own project, My Werk, which nobody else joins.

Defaultfalse
capabilitiesobject

What the key's person may do with the project now.

Show properties of capabilitiesHide properties of capabilities
inviteboolean

True when the key's person may invite people to the project.

managePeopleboolean

True when they may manage the project's people.

changeRolesboolean

True when they may make a person an admin or a member.

removePeopleboolean

True when they may remove people from the project.

editListsboolean

True when they may change the project's steps.

archiveboolean

True when they may archive the project.

restoreboolean

True when they may bring the project back from the archive.

deleteboolean

True when they may delete the project.

transferOwnershipboolean

True when they may hand the project to another person and leave it.

renameboolean

True when they may rename the project.

changePhotoboolean

True when they may change the project's photo.

leaveboolean

True when they may leave the project.

titlestring

The project's name.

lastActivityAtstring

When something last happened in the project that the key's person sees: a chat message or a card change.

isOwnerboolean

True when the key's person owns the project.

ownerNamestring

The owner's name.

memberCountinteger

How many people the project has.

At least 0
membersarray of objects

A few of the project's people, for its avatars.

Up to 3 items
Show properties of membersHide properties of members
idstring, uuid

The person's id.

firstNamestring

The person's first name.

initialsstring

The person's initials, for an avatar with no photo.

photoobject

The person's photo, when they have one.

Show properties of photoHide properties of photo
personIdstring, uuid

The person whose photo it is.

versioninteger

The photo's version, which changes with the photo; its read takes it to fetch the current one.

At least 1
viewerRoleenum

The key's person's role in the project.

Allowed valuesowneradminmembercollaborator
photoobject or null

The project's photo, or null when it has none.

Show properties of photoHide properties of photo
versioninteger

The photo's version, which changes with the photo; its read takes it to fetch the current one.

At least 1
dueTodayCountinteger

Open cards due today.

At least 0
closedCardCountinteger

Cards on the project's last step, archived ones included.

At least 0
openCardCountinteger

Cards neither archived nor on the project's last step.

At least 0
offerTranslationobject

Present while Werk offers the key's person to translate the project's cards that others wrote in other languages.

Show properties of offerTranslationHide properties of offerTranslation
languagesarray of strings

The languages those cards are written in.

From 1 to 20 items, each from 2 to 64 characters
targetstring

The key's person's language, which they would be translated into.

currentOpenCardCountinteger

The project's open cards, as its card list counts them.

At least 0
projectConfigVersioninteger

The version of the project's settings (its name, steps and archive), which grows with each change to them; such a change sends it as expectedConfigVersion.

At least 1
stepsobject

The new project's steps.

Show properties of stepsHide properties of steps
capabilitiesobject

What the key's person may do with the project now.

Show properties of capabilitiesHide properties of capabilities
inviteboolean

True when the key's person may invite people to the project.

managePeopleboolean

True when they may manage the project's people.

changeRolesboolean

True when they may make a person an admin or a member.

removePeopleboolean

True when they may remove people from the project.

editListsboolean

True when they may change the project's steps.

archiveboolean

True when they may archive the project.

restoreboolean

True when they may bring the project back from the archive.

deleteboolean

True when they may delete the project.

transferOwnershipboolean

True when they may hand the project to another person and leave it.

renameboolean

True when they may rename the project.

changePhotoboolean

True when they may change the project's photo.

leaveboolean

True when they may leave the project.

configVersioninteger

The version of the project's settings (its name, steps and archive), which grows with each change to them; such a change sends it as expectedConfigVersion.

At least 1
stepsarray of objects

The project's steps, in order.

From 2 to 100 items
Show properties of stepsHide properties of steps
idstring

The step's id; a card's step names it as stepId.

Up to 64 characters
labelstring

The step's name, in the reader's language when it is one of Werk's own words.

From 1 to 60 characters
labelLanguagestring

The language a name the project wrote is written in; absent for one of Werk's own words.

From 2 to 64 characters
labelTranslationobject

A name the project wrote, in the reader's language, when it is written in another.

Show properties of labelTranslationHide properties of labelTranslation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

labelSourceobject

The name as stored: one of Werk's own words, or a name as written. A change of steps sends it back as label.

Show properties of labelSourceHide properties of labelSource

One of 2 shapes, told apart by kind:

kindlocale_key
kindenum

locale_key for one of Werk's own words, text for a name as written.

Allowed valueslocale_key
keyenum

Which of Werk's own words names the step.

Allowed valuesproject_steps.steps.openproject_steps.steps.in_progressproject_steps.steps.waiting_partsproject_steps.steps.doneproject_steps.steps.paidproject_steps.steps.in_review
kindtext
kindenum

locale_key for one of Werk's own words, text for a name as written.

Allowed valuestext
textstring

The name, as written.

From 1 to 60 characters
bucketenum

The kind of step: new for an open step, in_progress or waiting for one in between, resolved or closed for one that ends the work.

Allowed valuesnewin_progresswaitingresolvedclosed
positioninteger

The step's place among the project's steps, from 0.

From 0 to 99
cardCountinteger

How many cards are on the step.

At least 0

Errors

400invalid_queryThe query is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
400invalid_project_nameThe project name is missing, empty once trimmed, or longer in characters than it holds.
400too_few_project_stepsThe project would have fewer steps than a project needs.
400too_many_project_stepsThe project would hold more steps than a project holds.
400duplicate_project_stepTwo of the steps sent are the same step.
400project_first_step_not_openThe steps sent put a step that is not of an open kind first.
400project_last_step_not_finishedThe steps sent put a step that is not of a finished kind last.
400invalid_project_step_labelA step's name is missing, empty once trimmed, or longer in characters than it holds.
400invalid_project_requestThe project request is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
400photo_side_too_largeThe photo's longer side has more pixels than this request takes.
400unsupported_media_typeThe file's type is not one the route takes.
400invalid_mediaThe file, its name or the request about it is not in a form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
403not_for_clientThe route, setting or input the request names is open only to Werk's own apps, and the request's session is a connected app's or an API key's.
404asset_not_foundThe file the request names is not one the signed-in person can reach where the request names it, or is no longer available.
404template_not_foundThe step template the request names is not one the signed-in person has.
409session_changedThe session changed while the request was in flight.
409request_conflictThe request id was already used with another request, or the change it asks could not be made to the record it names.
409request_erasedThe request id belongs to a request whose record was erased.
409reserved_project_nameThe project name is one Werk keeps for the person's own My Werk.
409project_config_changedThe project's setup, or the projects the request covers, changed after the version the request names or while it ran.
413payload_too_largeThe request body has more bytes than the route takes.
rate_limitedMore requests of this kind were sent than Werk takes within the time it counts them over.
500server_errorThe server could not complete the request, and it is not known whether a write it holds was made.
curl
curl -X POST "https://api.getwerk.ai/api/v1/projects" \
  -H "Authorization: Bearer wk_key_..." \
  -H "Content-Type: application/json" \
  -d '{
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b01",
    "name": "Harbor Street kitchen",
    "templateId": "technicians"
  }'
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects", {
  method: "POST",
  headers: {
    Authorization: "Bearer wk_key_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4b01",
    "name": "Harbor Street kitchen",
    "templateId": "technicians"
  }),
});
const answer = await res.json();
201JSON
{
  "conversation": {
    "projectId": "2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73",
    "color": "turquoise",
    "highlighted": false,
    "appearanceRevision": 1,
    "id": "9e3b1c75-4f2a-4d86-b0c9-5a7e2d1f8c36",
    "listPosition": 0,
    "peopleVersion": 1,
    "statusLine": null,
    "statusLineAt": null,
    "archived": false,
    "personal": false,
    "capabilities": {
      "invite": true,
      "managePeople": true,
      "changeRoles": true,
      "removePeople": true,
      "editLists": true,
      "archive": true,
      "restore": false,
      "delete": true,
      "transferOwnership": true,
      "rename": true,
      "changePhoto": true,
      "leave": true
    },
    "title": "Harbor Street kitchen",
    "lastActivityAt": "2026-11-21T13:35:00.000Z",
    "isOwner": true,
    "ownerName": "Maya Chen",
    "memberCount": 1,
    "members": [
      {
        "id": "5d1f3a2e-8c4b-4e7a-9f21-3b6c8d0e1a42",
        "firstName": "Maya",
        "initials": "MC"
      }
    ],
    "viewerRole": "owner",
    "photo": null,
    "dueTodayCount": 0,
    "closedCardCount": 0,
    "openCardCount": 0,
    "currentOpenCardCount": 0,
    "projectConfigVersion": 1
  },
  "steps": {
    "capabilities": {
      "invite": true,
      "managePeople": true,
      "changeRoles": true,
      "removePeople": true,
      "editLists": true,
      "archive": true,
      "restore": false,
      "delete": true,
      "transferOwnership": true,
      "rename": true,
      "changePhoto": true,
      "leave": true
    },
    "configVersion": 1,
    "steps": [
      {
        "id": "open",
        "label": "Pending",
        "labelSource": {
          "kind": "locale_key",
          "key": "project_steps.steps.open"
        },
        "bucket": "new",
        "position": 0,
        "cardCount": 0
      },
      {
        "id": "in_progress",
        "label": "In progress",
        "labelSource": {
          "kind": "locale_key",
          "key": "project_steps.steps.in_progress"
        },
        "bucket": "in_progress",
        "position": 1,
        "cardCount": 0
      },
      {
        "id": "waiting_parts",
        "label": "Waiting for parts",
        "labelSource": {
          "kind": "locale_key",
          "key": "project_steps.steps.waiting_parts"
        },
        "bucket": "waiting",
        "position": 2,
        "cardCount": 0
      },
      {
        "id": "done",
        "label": "Done",
        "labelSource": {
          "kind": "locale_key",
          "key": "project_steps.steps.done"
        },
        "bucket": "resolved",
        "position": 3,
        "cardCount": 0
      },
      {
        "id": "paid",
        "label": "Paid",
        "labelSource": {
          "kind": "locale_key",
          "key": "project_steps.steps.paid"
        },
        "bucket": "closed",
        "position": 4,
        "cardCount": 0
      }
    ]
  }
}