La référence de l'API est publiée en anglais.

Create a project

POST/api/companies/{companyId}/projects
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

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.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

idempotencyKeystringFacultatif1–255 characters
goalIdstring (uuid) | nullFacultatif
goalIdsarray<string (uuid)>Facultatif
namestringObligatoireat least 1 character
descriptionstring | nullFacultatif
visibilitystringFacultatifone of: "open", "private"
statusstringFacultatifone of: "backlog", "planned", "in_progress", "completed", "cancelled"
leadAgentIdstring (uuid) | nullFacultatif
decisionOwnerUserIdstring | nullFacultatifat least 1 character
targetDatestring | nullFacultatif
colorstring | nullFacultatif
iconstring | nullFacultatifone 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> | nullFacultatif
executionWorkspacePolicyobject | nullFacultatif
executionWorkspacePolicy.enabledbooleanObligatoire
executionWorkspacePolicy.sharedWorkspaceConcurrencystringFacultatifone of: "auto", "serialize", "allow"
executionWorkspacePolicy.defaultModestringFacultatifone of: "shared_workspace", "isolated_workspace", "operator_branch", "adapter_default"
executionWorkspacePolicy.allowIssueOverridebooleanFacultatif
executionWorkspacePolicy.defaultProjectWorkspaceIdstring (uuid) | nullFacultatif
executionWorkspacePolicy.environmentIdstring (uuid) | nullFacultatif
executionWorkspacePolicy.storageProviderPluginIdstring (uuid) | nullFacultatif
executionWorkspacePolicy.workspaceStrategyobject | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.typestringFacultatifone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspacePolicy.workspaceStrategy.baseRefstring | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.branchTemplatestring | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.worktreeParentDirstring | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.provisionCommandstring | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.runtimeProvisionCommandstring | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.teardownCommandstring | nullFacultatif
executionWorkspacePolicy.workspaceRuntimeobject | nullFacultatif
executionWorkspacePolicy.branchPolicyobject | nullFacultatif
executionWorkspacePolicy.pullRequestPolicyobject | nullFacultatif
executionWorkspacePolicy.runtimePolicyobject | nullFacultatif
executionWorkspacePolicy.cleanupPolicyobject | nullFacultatif
executionWorkspacePolicy.authorizationPolicyobject | nullFacultatif
executionWorkspacePolicy.authorizationPolicy.trustPresetstringFacultatifone of: "standard", "low_trust_review"
executionWorkspacePolicy.authorizationPolicy.reviewPresetobjectFacultatif
executionWorkspacePolicy.authorizationPolicy.trustBoundaryobjectFacultatif
executionWorkspacePolicy.authorizationPolicy.assignmentPolicyobjectFacultatif
executionWorkspacePolicy.authorizationPolicy.protectedAgentobjectFacultatif
archivedAtstring (date-time) | nullFacultatif
environmentIdstring (uuid)Facultatif
expectedStorageProviderPluginIdstring (uuid) | nullFacultatif
workspaceobjectFacultatif
workspace.namestringFacultatifat least 1 character
workspace.sourceTypestringFacultatifone of: "local_path", "git_repo", "remote_managed", "non_git_path"
workspace.cwdstring | nullFacultatifat least 1 character
workspace.repoUrlstring (uri) | nullFacultatif
workspace.repoRefstring | nullFacultatif
workspace.defaultRefstring | nullFacultatif
workspace.visibilitystringFacultatifone of: "default", "advanced"
workspace.setupCommandstring | nullFacultatif
workspace.cleanupCommandstring | nullFacultatif
workspace.remoteProviderstring | nullFacultatif
workspace.remoteWorkspaceRefstring | nullFacultatif
workspace.sharedWorkspaceKeystring | nullFacultatif
workspace.metadataobject | nullFacultatif
workspace.runtimeConfigobject | nullFacultatif
workspace.runtimeConfig.workspaceRuntimeobject | nullFacultatif
workspace.runtimeConfig.desiredStatestring | nullFacultatifone of: "running", "stopped", "manual"
workspace.runtimeConfig.serviceStatesobject<string, string> | nullFacultatif
workspace.isPrimarybooleanFacultatif
repositoryIdsarray<string>Facultatif
repositoryUrlsarray<string (uri)>Facultatifeach at most 2000 characters

Réponses

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

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Projects