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

Manually run a routine

POST/api/routines/{id}/run
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

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.

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

idstringObligatoireThe routine's id.

Corps de la requête

application/json · obligatoire

triggerIdstring (uuid) | nullFacultatif
payloadobject | nullFacultatif
variablesobject<string, string | number | boolean> | nullFacultatif
projectIdstring (uuid) | nullFacultatif
projectWorkspaceIdstring (uuid) | nullFacultatif
assigneeAgentIdstring (uuid) | nullFacultatif
idempotencyKeystring | nullFacultatifat most 255 characters
sourcestringFacultatifone of: "manual", "api"
executionWorkspaceIdstring (uuid) | nullFacultatif
executionWorkspacePreferencestring | nullFacultatifone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
executionWorkspaceSettingsobject | nullFacultatif
executionWorkspaceSettings.modestringFacultatifone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
executionWorkspaceSettings.sharedWorkspaceConcurrencystringFacultatifone of: "auto", "serialize", "allow"
executionWorkspaceSettings.environmentIdstring (uuid) | nullFacultatif
executionWorkspaceSettings.workspaceStrategyobject | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.typestringFacultatifone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspaceSettings.workspaceStrategy.baseRefstring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.branchTemplatestring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.existingBranchstring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.worktreeParentDirstring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.provisionCommandstring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.runtimeProvisionCommandstring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.teardownCommandstring | nullFacultatif
executionWorkspaceSettings.workspaceRuntimeobject | nullFacultatif
executionWorkspaceSettings.networkEgressobject | nullFacultatif
executionWorkspaceSettings.networkEgress.allowFqdnsarray<string>Facultatifeach at most 253 characters
executionWorkspaceSettings.networkEgress.allowCidrsarray<string>Facultatifeach at most 64 characters

Réponses

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

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

Routines