Projects

Create project

Creates an empty saved project for the authenticated API key owner. Use Idempotency-Key so retries do not create duplicate projects.

post/api/v1/projects

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

Headers

Idempotency-Keystring nullable
authorizationstring nullable

Request body

namestring
externalIdstring nullable
externalUserIdstring nullable
externalWorkspaceIdstring nullable
metadataobject

Developer-defined metadata stored for correlation. Not filterable unless promoted to an indexed field.

Example request

{
  "externalId": "workspace_123",
  "externalUserId": "user_789",
  "externalWorkspaceId": "team_456",
  "metadata": {
    "plan": "pro"
  },
  "name": "Jane's Workspace"
}

Response

Created 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.