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

Manually run a routine

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

Manually run a routine.

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

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

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

Тело запроса

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

triggerIdstring (uuid) | nullНеобязательный
payloadobject | nullНеобязательный
variablesobject<string, string | number | boolean> | nullНеобязательный
projectIdstring (uuid) | nullНеобязательный
projectWorkspaceIdstring (uuid) | nullНеобязательный
assigneeAgentIdstring (uuid) | nullНеобязательный
idempotencyKeystring | nullНеобязательныйat most 255 characters
sourcestringНеобязательныйone of: "manual", "api"
executionWorkspaceIdstring (uuid) | nullНеобязательный
executionWorkspacePreferencestring | nullНеобязательныйone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
executionWorkspaceSettingsobject | nullНеобязательный
executionWorkspaceSettings.modestringНеобязательныйone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
executionWorkspaceSettings.sharedWorkspaceConcurrencystringНеобязательныйone of: "auto", "serialize", "allow"
executionWorkspaceSettings.environmentIdstring (uuid) | nullНеобязательный
executionWorkspaceSettings.workspaceStrategyobject | nullНеобязательный
executionWorkspaceSettings.workspaceStrategy.typestringНеобязательныйone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspaceSettings.workspaceStrategy.baseRefstring | nullНеобязательный
executionWorkspaceSettings.workspaceStrategy.branchTemplatestring | nullНеобязательный
executionWorkspaceSettings.workspaceStrategy.existingBranchstring | nullНеобязательный
executionWorkspaceSettings.workspaceStrategy.worktreeParentDirstring | nullНеобязательный
executionWorkspaceSettings.workspaceStrategy.provisionCommandstring | nullНеобязательный
executionWorkspaceSettings.workspaceStrategy.runtimeProvisionCommandstring | nullНеобязательный
executionWorkspaceSettings.workspaceStrategy.teardownCommandstring | nullНеобязательный
executionWorkspaceSettings.workspaceRuntimeobject | nullНеобязательный
executionWorkspaceSettings.networkEgressobject | nullНеобязательный
executionWorkspaceSettings.networkEgress.allowFqdnsarray<string>Необязательныйeach at most 253 characters
executionWorkspaceSettings.networkEgress.allowCidrsarray<string>Необязательныйeach at most 64 characters

Ответы

200SuccessThe request worked; the body holds the result.
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. Подробнее: ошибки и ограничения.

Routines