Create a project
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
Authorization: Bearer <key> Authentication
Headers
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
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.
A photo uploaded first with POST /assets, made the project's photo.
The project's name.
The step template the project's steps come from; left out, Werk's own Simple template.
The project's steps, in order; given, they are taken instead of the template's.
Show properties of stepsHide properties of steps
The step's id: an existing step's id keeps that step and its cards, a new id adds a step.
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_locale_key for one of Werk's own words, written in each reader's language; text for a name as written.
Which of Werk's own words names the step.
kindtextlocale_key for one of Werk's own words, written in each reader's language; text for a name as written.
The step's name, as written.
The kind of step: the first step must be new, in_progress or waiting, and the last resolved or closed.
Response
201 The new project and its steps.
The new project, as the key's person sees it in their list.
Show properties of conversationHide properties of conversation
The project's id.
The color the key's person sees the project in.
True when the key's person marked the project to stand out in their list.
Grows with each change to the key's person's color or mark for the project.
The id Werk's apps use for the key's person's view of this project; the API's paths take projectId.
The key's person's own place for the project in their list, or null while they never ordered it.
The version of the project's people, which changes whenever its people do.
One line Werk writes from the project's cards on how the project is going, or null before there is one.
When that line was written.
True when the project is archived.
True for the key's person's own project, My Werk, which nobody else joins.
What the key's person may do with the project now.
Show properties of capabilitiesHide properties of capabilities
True when the key's person may invite people to the project.
True when they may manage the project's people.
True when they may make a person an admin or a member.
True when they may remove people from the project.
True when they may change the project's steps.
True when they may archive the project.
True when they may bring the project back from the archive.
True when they may delete the project.
True when they may hand the project to another person and leave it.
True when they may rename the project.
True when they may change the project's photo.
True when they may leave the project.
The project's name.
When something last happened in the project that the key's person sees: a chat message or a card change.
True when the key's person owns the project.
The owner's name.
How many people the project has.
A few of the project's people, for its avatars.
Show properties of membersHide properties of members
The person's id.
The person's first name.
The person's initials, for an avatar with no photo.
The person's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The key's person's role in the project.
The project's photo, or null when it has none.
Show properties of photoHide properties of photo
The photo's version, which changes with the photo; its read takes it to fetch the current one.
Open cards due today.
Cards on the project's last step, archived ones included.
Cards neither archived nor on the project's last step.
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
The languages those cards are written in.
The key's person's language, which they would be translated into.
The project's open cards, as its card list counts them.
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.
The new project's steps.
Show properties of stepsHide properties of steps
What the key's person may do with the project now.
Show properties of capabilitiesHide properties of capabilities
True when the key's person may invite people to the project.
True when they may manage the project's people.
True when they may make a person an admin or a member.
True when they may remove people from the project.
True when they may change the project's steps.
True when they may archive the project.
True when they may bring the project back from the archive.
True when they may delete the project.
True when they may hand the project to another person and leave it.
True when they may rename the project.
True when they may change the project's photo.
True when they may leave the project.
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.
The project's steps, in order.
Show properties of stepsHide properties of steps
The step's id; a card's step names it as stepId.
The step's name, in the reader's language when it is one of Werk's own words.
The language a name the project wrote is written in; absent for one of Werk's own words.
A name the project wrote, in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
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.
The translated text, present once ready.
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_locale_key for one of Werk's own words, text for a name as written.
Which of Werk's own words names the step.
kindtextlocale_key for one of Werk's own words, text for a name as written.
The name, as written.
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.
The step's place among the project's steps, from 0.
How many cards are on the step.
Errors
invalid_query The 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).invalid_project_name The project name is missing, empty once trimmed, or longer in characters than it holds.too_few_project_steps The project would have fewer steps than a project needs.too_many_project_steps The project would hold more steps than a project holds.duplicate_project_step Two of the steps sent are the same step.project_first_step_not_open The steps sent put a step that is not of an open kind first.project_last_step_not_finished The steps sent put a step that is not of a finished kind last.invalid_project_step_label A step's name is missing, empty once trimmed, or longer in characters than it holds.invalid_project_request The 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).photo_side_too_large The photo's longer side has more pixels than this request takes.unsupported_media_type The file's type is not one the route takes.invalid_media The 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).session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.not_for_client The 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.asset_not_found The file the request names is not one the signed-in person can reach where the request names it, or is no longer available.template_not_found The step template the request names is not one the signed-in person has.session_changed The session changed while the request was in flight.request_conflict The request id was already used with another request, or the change it asks could not be made to the record it names.request_erased The request id belongs to a request whose record was erased.reserved_project_name The project name is one Werk keeps for the person's own My Werk.project_config_changed The project's setup, or the projects the request covers, changed after the version the request names or while it ran.payload_too_large The request body has more bytes than the route takes.rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.server_error The server could not complete the request, and it is not known whether a write it holds was made.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"
}'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();{
"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
}
]
}
}Send a requestPOST
It is sent with the key you give, as you. A change made here is real.
The request could not be sent, or its response could not be read.