Projects

Update project metadata

Updates project display metadata and developer-provided external identifiers using optimistic concurrency. Prefer this explicit route for metadata-only updates; PATCH /projects/{project_id} is kept as a compatibility alias.

patch/api/v1/projects/{project_id}/metadata

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}/metadata
  • Auth: HTTP bearer

Path parameters

project_idstring required

Headers

authorizationstring nullable

Request body

namestring nullable
externalIdstring nullable
externalUserIdstring nullable
externalWorkspaceIdstring nullable
metadataobject nullable
expectedVersioninteger required

Last project version observed by the client.

Example request

{
  "expectedVersion": 1,
  "externalUserId": "user_789",
  "metadata": {
    "plan": "enterprise"
  },
  "name": "Jane's Renamed Workspace"
}

Response

Updated project metadata.

idstring required

Stable project identifier.

namestring required

Project display name.

externalIdstring nullable

Developer-provided external project/workspace identifier.

externalUserIdstring nullable

Developer-provided identifier for the developer's own end user.

externalWorkspaceIdstring nullable

Developer-provided identifier for the developer's own workspace/team.

nodeCountinteger required

Number of nodes in the project graph.

createdAtstring date-time nullable

Project creation timestamp, when available.

updatedAtstring date-time nullable

Most recent project update timestamp, when available.

thumbnailUrlstring nullable

Short-lived signed thumbnail URL, when a project thumbnail is available.

thumbnailExpiresAtstring date-time nullable

Expiration timestamp for thumbnailUrl, when present.

versioninteger required

Optimistic concurrency version for the project.

Example response

{
  "createdAt": "2026-05-21T14:21:52.152049+00:00",
  "externalId": "workspace_123",
  "externalUserId": "user_789",
  "externalWorkspaceId": "team_456",
  "id": "proj_123",
  "name": "Machine",
  "nodeCount": 12,
  "updatedAt": "2026-05-21T15:10:03.000000+00:00",
  "version": 7
}

Changes

No recorded changes to this operation across all 1 revision of this API.