Справочник API публикуется на английском языке.

Create a project

POST/api/companies/{companyId}/projects
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

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.

Авторизация

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. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Тело запроса

application/json · обязательно

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

Ответы

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

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Projects