Manually run a routine

POST/api/routines/{id}/run
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

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.

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

idstringRequiredThe routine's id.

Request body

application/json · required

triggerIdstring (uuid) | nullOptional
payloadobject | nullOptional
variablesobject<string, string | number | boolean> | nullOptional
projectIdstring (uuid) | nullOptional
projectWorkspaceIdstring (uuid) | nullOptional
assigneeAgentIdstring (uuid) | nullOptional
idempotencyKeystring | nullOptionalat most 255 characters
sourcestringOptionalone of: "manual", "api"
executionWorkspaceIdstring (uuid) | nullOptional
executionWorkspacePreferencestring | nullOptionalone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
executionWorkspaceSettingsobject | nullOptional
executionWorkspaceSettings.modestringOptionalone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
executionWorkspaceSettings.sharedWorkspaceConcurrencystringOptionalone of: "auto", "serialize", "allow"
executionWorkspaceSettings.environmentIdstring (uuid) | nullOptional
executionWorkspaceSettings.workspaceStrategyobject | nullOptional
executionWorkspaceSettings.workspaceStrategy.typestringOptionalone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspaceSettings.workspaceStrategy.baseRefstring | nullOptional
executionWorkspaceSettings.workspaceStrategy.branchTemplatestring | nullOptional
executionWorkspaceSettings.workspaceStrategy.existingBranchstring | nullOptional
executionWorkspaceSettings.workspaceStrategy.worktreeParentDirstring | nullOptional
executionWorkspaceSettings.workspaceStrategy.provisionCommandstring | nullOptional
executionWorkspaceSettings.workspaceStrategy.runtimeProvisionCommandstring | nullOptional
executionWorkspaceSettings.workspaceStrategy.teardownCommandstring | nullOptional
executionWorkspaceSettings.workspaceRuntimeobject | nullOptional
executionWorkspaceSettings.networkEgressobject | nullOptional
executionWorkspaceSettings.networkEgress.allowFqdnsarray<string>Optionaleach at most 253 characters
executionWorkspaceSettings.networkEgress.allowCidrsarray<string>Optionaleach at most 64 characters

Responses

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

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Routines