---
title: "Update project"
method: PATCH
path: "/api/v1/projects/{project_id}"
tags: ["Projects"]
---

# Update project

`PATCH /api/v1/projects/{project_id}`

## Request

- Base URL: `https://api.studio.kaitoi.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.studio.kaitoi.io/api/v1/projects/{project_id}`
- Auth: HTTP bearer

Updates project display metadata and developer-provided external identifiers using optimistic concurrency.

## Path parameters

- `project_id` string, required

## Headers

- `authorization` string, nullable

## Request body

- PublicProjectUpdateRequest
  - `name` string, nullable
  - `externalId` string, nullable
  - `externalUserId` string, nullable
  - `externalWorkspaceId` string, nullable
  - `metadata` object, nullable
  - `expectedVersion` integer, required: Last project version observed by the client.

## Response `200`

Updated project metadata.

- PublicProjectDetail
  - `id` string, required: Stable project identifier.
  - `name` string, required: Project display name.
  - `externalId` string, nullable: Developer-provided external project/workspace identifier.
  - `externalUserId` string, nullable: Developer-provided identifier for the developer's own end user.
  - `externalWorkspaceId` string, nullable: Developer-provided identifier for the developer's own workspace/team.
  - `nodeCount` integer, required: Number of nodes in the project graph.
  - `createdAt` string, date-time, nullable: Project creation timestamp, when available.
  - `updatedAt` string, date-time, nullable: Most recent project update timestamp, when available.
  - `thumbnailUrl` string, nullable: Short-lived signed thumbnail URL, when a project thumbnail is available.
  - `thumbnailExpiresAt` string, date-time, nullable: Expiration timestamp for thumbnailUrl, when present.
  - `version` integer, required: Optimistic concurrency version for the project.

## Other responses

- `401`: Missing, malformed, expired, or revoked bearer token.
- `403`: The API key lacks the required scope or account capability.
- `404`: The project does not exist or is not owned by this user.
- `409`: The expected project version is stale.
- `422`: Validation Error
- `429`: The client or API key exceeded the REST API rate limit.
- `503`: The shared REST API rate limiter is temporarily unavailable.

---

[API](https://skmtc.dev/kaitoi/apis/kaitoi-rest-api.md) · [All operations](https://skmtc.dev/kaitoi/apis/kaitoi-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kaitoi/apis/kaitoi-rest-api/revisions/239a74aa2c64?raw)
