Skip to main content
POST
cURL

Authorizations

Authorization
string
header
default:dav_ak_live_your_token
required

Personal access token. The scopes granted at issuance determine both which operations the key may call and the ceiling on the resource permissions it can exercise. Each scope family is a ladder: projects:manage implies projects:write and projects:read; cards:manage implies cards:write and cards:read; and teams:manage implies teams:write and teams:read. These are named API capability bundles, not blanket domain roles: manage exposes only the permissions enumerated for that scope and never bypasses the acting user's current role-based access.

Path Parameters

projectId
string
required

Project id. May be compound in the form {projectId}--{branchName}.

Minimum string length: 1

Body

application/json
branch
string
default:main
oldProjectId
string

Previously open project to close as part of switching.

initialPrompt
string
Maximum string length: 4000

Response

Project is loaded and ready.

projectId
string
required
branchName
string
required
alreadyLoaded
boolean
required

True when the project was already running and this call reused the instance.

permissions
string[]
required
metadata
object

Stored project metadata. ProjectSummary is this plus the live inUse and activeBranch fields that only the list endpoint computes.

url
string

Design Engine replica URL. Present only for browser access-token callers; omitted for API keys.

serverToken
string

Project instance credential. Present only for browser access-token callers; omitted for API keys.