Create a project
POST
/api/companies/{companyId}/projectsPersonal API keyAgent API keyConsole session
Create a project.
The optional repositoryIds field selects GitHub source repositories and requires a board caller. It cannot be combined with workspace. All selections are validated before the project and repository workspaces are created atomically.
Idempotency. Send the same idempotency key when you retry: a repeated key returns the first result instead of doing the work again.
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Path parameters
companyIdstringRequiredThe organization's id.
Request body
application/json · required
idempotencyKeystringOptional
1–255 charactersgoalIdstring (uuid) | nullOptional
goalIdsarray<string (uuid)>Optional
namestringRequired
at least 1 characterdescriptionstring | nullOptional
visibilitystringOptional
one of: "open", "private"statusstringOptional
one of: "backlog", "planned", "in_progress", "completed", "cancelled"leadAgentIdstring (uuid) | nullOptional
decisionOwnerUserIdstring | nullOptional
at least 1 charactertargetDatestring | nullOptional
colorstring | nullOptional
iconstring | nullOptional
one of: "folder", "rocket", "code", "terminal", "database", "globe", "package", "boxes", "box", "layers", "briefcase", "compass", "target", "flame", "zap", "star", "bug", "wrench", "hammer", "lightbulb", "sparkles", "shield", "lock", "search", "cog", "brain", "cpu", "git-branch", "file-code", "puzzle", "gem", "atom", "heart", "mail", "message-square", "crown", "radar", "telescope", "hexagon"envobject<string, string | object> | nullOptional
executionWorkspacePolicyobject | nullOptional
executionWorkspacePolicy.enabledbooleanRequired
executionWorkspacePolicy.sharedWorkspaceConcurrencystringOptional
one of: "auto", "serialize", "allow"executionWorkspacePolicy.defaultModestringOptional
one of: "shared_workspace", "isolated_workspace", "operator_branch", "adapter_default"executionWorkspacePolicy.allowIssueOverridebooleanOptional
executionWorkspacePolicy.defaultProjectWorkspaceIdstring (uuid) | nullOptional
executionWorkspacePolicy.environmentIdstring (uuid) | nullOptional
executionWorkspacePolicy.storageProviderPluginIdstring (uuid) | nullOptional
executionWorkspacePolicy.workspaceStrategyobject | nullOptional
executionWorkspacePolicy.workspaceStrategy.typestringOptional
one of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"executionWorkspacePolicy.workspaceStrategy.baseRefstring | nullOptional
executionWorkspacePolicy.workspaceStrategy.branchTemplatestring | nullOptional
executionWorkspacePolicy.workspaceStrategy.worktreeParentDirstring | nullOptional
executionWorkspacePolicy.workspaceStrategy.provisionCommandstring | nullOptional
executionWorkspacePolicy.workspaceStrategy.runtimeProvisionCommandstring | nullOptional
executionWorkspacePolicy.workspaceStrategy.teardownCommandstring | nullOptional
executionWorkspacePolicy.workspaceRuntimeobject | nullOptional
executionWorkspacePolicy.branchPolicyobject | nullOptional
executionWorkspacePolicy.pullRequestPolicyobject | nullOptional
executionWorkspacePolicy.runtimePolicyobject | nullOptional
executionWorkspacePolicy.cleanupPolicyobject | nullOptional
executionWorkspacePolicy.authorizationPolicyobject | nullOptional
executionWorkspacePolicy.authorizationPolicy.trustPresetstringOptional
one of: "standard", "low_trust_review"executionWorkspacePolicy.authorizationPolicy.reviewPresetobjectOptional
executionWorkspacePolicy.authorizationPolicy.trustBoundaryobjectOptional
executionWorkspacePolicy.authorizationPolicy.assignmentPolicyobjectOptional
executionWorkspacePolicy.authorizationPolicy.protectedAgentobjectOptional
archivedAtstring (date-time) | nullOptional
environmentIdstring (uuid)Optional
expectedStorageProviderPluginIdstring (uuid) | nullOptional
workspaceobjectOptional
workspace.namestringOptional
at least 1 characterworkspace.sourceTypestringOptional
one of: "local_path", "git_repo", "remote_managed", "non_git_path"workspace.cwdstring | nullOptional
at least 1 characterworkspace.repoUrlstring (uri) | nullOptional
workspace.repoRefstring | nullOptional
workspace.defaultRefstring | nullOptional
workspace.visibilitystringOptional
one of: "default", "advanced"workspace.setupCommandstring | nullOptional
workspace.cleanupCommandstring | nullOptional
workspace.remoteProviderstring | nullOptional
workspace.remoteWorkspaceRefstring | nullOptional
workspace.sharedWorkspaceKeystring | nullOptional
workspace.metadataobject | nullOptional
workspace.runtimeConfigobject | nullOptional
workspace.runtimeConfig.workspaceRuntimeobject | nullOptional
workspace.runtimeConfig.desiredStatestring | nullOptional
one of: "running", "stopped", "manual"workspace.runtimeConfig.serviceStatesobject<string, string> | nullOptional
workspace.isPrimarybooleanOptional
repositoryIdsarray<string>Optional
repositoryUrlsarray<string (uri)>Optional
each at most 2000 charactersResponses
201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
Errors return {"error": "..."}, often with a code and details. See errors and limits.