API referansı İngilizce yayımlanır.

Create a project

POST/api/companies/{companyId}/projects
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

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.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

idempotencyKeystringİsteğe bağlı1–255 characters
goalIdstring (uuid) | nullİsteğe bağlı
goalIdsarray<string (uuid)>İsteğe bağlı
namestringZorunluat least 1 character
descriptionstring | nullİsteğe bağlı
visibilitystringİsteğe bağlıone of: "open", "private"
statusstringİsteğe bağlıone of: "backlog", "planned", "in_progress", "completed", "cancelled"
leadAgentIdstring (uuid) | nullİsteğe bağlı
decisionOwnerUserIdstring | nullİsteğe bağlıat least 1 character
targetDatestring | nullİsteğe bağlı
colorstring | nullİsteğe bağlı
iconstring | nullİsteğe bağlı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> | nullİsteğe bağlı
executionWorkspacePolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.enabledbooleanZorunlu
executionWorkspacePolicy.sharedWorkspaceConcurrencystringİsteğe bağlıone of: "auto", "serialize", "allow"
executionWorkspacePolicy.defaultModestringİsteğe bağlıone of: "shared_workspace", "isolated_workspace", "operator_branch", "adapter_default"
executionWorkspacePolicy.allowIssueOverridebooleanİsteğe bağlı
executionWorkspacePolicy.defaultProjectWorkspaceIdstring (uuid) | nullİsteğe bağlı
executionWorkspacePolicy.environmentIdstring (uuid) | nullİsteğe bağlı
executionWorkspacePolicy.storageProviderPluginIdstring (uuid) | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategyobject | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.typestringİsteğe bağlıone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspacePolicy.workspaceStrategy.baseRefstring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.branchTemplatestring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.worktreeParentDirstring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.provisionCommandstring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.runtimeProvisionCommandstring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.teardownCommandstring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceRuntimeobject | nullİsteğe bağlı
executionWorkspacePolicy.branchPolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.pullRequestPolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.runtimePolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.cleanupPolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.authorizationPolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.authorizationPolicy.trustPresetstringİsteğe bağlıone of: "standard", "low_trust_review"
executionWorkspacePolicy.authorizationPolicy.reviewPresetobjectİsteğe bağlı
executionWorkspacePolicy.authorizationPolicy.trustBoundaryobjectİsteğe bağlı
executionWorkspacePolicy.authorizationPolicy.assignmentPolicyobjectİsteğe bağlı
executionWorkspacePolicy.authorizationPolicy.protectedAgentobjectİsteğe bağlı
archivedAtstring (date-time) | nullİsteğe bağlı
environmentIdstring (uuid)İsteğe bağlı
expectedStorageProviderPluginIdstring (uuid) | nullİsteğe bağlı
workspaceobjectİsteğe bağlı
workspace.namestringİsteğe bağlıat least 1 character
workspace.sourceTypestringİsteğe bağlıone of: "local_path", "git_repo", "remote_managed", "non_git_path"
workspace.cwdstring | nullİsteğe bağlıat least 1 character
workspace.repoUrlstring (uri) | nullİsteğe bağlı
workspace.repoRefstring | nullİsteğe bağlı
workspace.defaultRefstring | nullİsteğe bağlı
workspace.visibilitystringİsteğe bağlıone of: "default", "advanced"
workspace.setupCommandstring | nullİsteğe bağlı
workspace.cleanupCommandstring | nullİsteğe bağlı
workspace.remoteProviderstring | nullİsteğe bağlı
workspace.remoteWorkspaceRefstring | nullİsteğe bağlı
workspace.sharedWorkspaceKeystring | nullİsteğe bağlı
workspace.metadataobject | nullİsteğe bağlı
workspace.runtimeConfigobject | nullİsteğe bağlı
workspace.runtimeConfig.workspaceRuntimeobject | nullİsteğe bağlı
workspace.runtimeConfig.desiredStatestring | nullİsteğe bağlıone of: "running", "stopped", "manual"
workspace.runtimeConfig.serviceStatesobject<string, string> | nullİsteğe bağlı
workspace.isPrimarybooleanİsteğe bağlı
repositoryIdsarray<string>İsteğe bağlı
repositoryUrlsarray<string (uri)>İsteğe bağlıeach at most 2000 characters

Yanıtlar

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

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Projects