Create a project
/v1/projects in the Projects API.
curl -X POST https://api.example.test/v1/projects \ -H "Authorization: Bearer $TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "name": "Customer Portal", "key": "CRM", "client_id": "c1a2b3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "tagline": "Self-service for retail customers", "methodology": "scrum", "lead_pm_id": "0c2d8a7e-4b1f-4d3e-9a6b-2f5e8c1d7a90", "target_launch_on": "2027-03-31", "budget_hours": 1200 }'Only name and key are required. The key is upper-cased, is two to six letters and digits starting with a letter, and must be free across everything the team ever had, archived and deleted projects included, because the references it prefixed stay in people's hands. The name is unique within the team. client_id must be one of the team's clients, and each lead must be a member of the team. status defaults to discovery, methodology to scrum and visibility to team; archived is never a status to send, archiving has its own endpoint.
A paragraph is enough. A project created with a name, a key and a description is ready for Heimdall to draft its components, environments, personas and epics from; the rest of the record can follow as the intake proceeds.
Answers 201 with the project and emits project.created.
Requires ability
The token must hold this ability, or the call is refused with 403.
Fires one event
Delivered to every endpoint subscribed to it once the change is made.
MCP tool
Runs the same action from an agent, behind the same ability.
Idempotent
Send the header on every call; the same key replays the original response for 24 hours.
Authorization
bearerToken A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.
In: header
Header Parameters
A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.
uuidRequest body
JSONWhat the request carriesRequiredapplication/json
A project to create or change. Only name and key are required on a create; on an update, a field left out keeps its value and a field sent as null is cleared. The key is upper-cased.
Responses
201Createdapplication/json
The project as a 201.
400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json
Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who registered a row answers FORBIDDEN with the same status, and says so in its own description.
On this endpoint: FORBIDDEN: when the token holder's role does not carry project:create.
404Not foundRESOURCE_NOT_FOUNDapplication/json
When client_id is not one of the team's clients.
409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json
The key was already used in the last 24 hours with a different request body.
422Validation failedVALIDATION_FAILEDapplication/json
The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a role code already taken or a team the caller does not own, uses the same code with error.message saying why and no fields.
On this endpoint: VALIDATION_FAILED: when a field is malformed, the key or the name is taken (error.context.key or error.context.name names it), or a lead is not a member of the team.
425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json
The first request with this key is still running; retry in a few seconds and the original response is replayed.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on