La referencia de la API se publica en inglés.
Manually run a routine
POST
/api/routines/{id}/runPersonal API keyAgent API keyConsole session
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.
Autorización
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. Cómo funcionan las claves.
Parámetros de ruta
idstringObligatorioThe routine's id.
Cuerpo de la solicitud
application/json · obligatorio
triggerIdstring (uuid) | nullOpcional
payloadobject | nullOpcional
variablesobject<string, string | number | boolean> | nullOpcional
projectIdstring (uuid) | nullOpcional
projectWorkspaceIdstring (uuid) | nullOpcional
assigneeAgentIdstring (uuid) | nullOpcional
idempotencyKeystring | nullOpcional
at most 255 characterssourcestringOpcional
one of: "manual", "api"executionWorkspaceIdstring (uuid) | nullOpcional
executionWorkspacePreferencestring | nullOpcional
one of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"executionWorkspaceSettingsobject | nullOpcional
executionWorkspaceSettings.modestringOpcional
one of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"executionWorkspaceSettings.sharedWorkspaceConcurrencystringOpcional
one of: "auto", "serialize", "allow"executionWorkspaceSettings.environmentIdstring (uuid) | nullOpcional
executionWorkspaceSettings.workspaceStrategyobject | nullOpcional
executionWorkspaceSettings.workspaceStrategy.typestringOpcional
one of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"executionWorkspaceSettings.workspaceStrategy.baseRefstring | nullOpcional
executionWorkspaceSettings.workspaceStrategy.branchTemplatestring | nullOpcional
executionWorkspaceSettings.workspaceStrategy.existingBranchstring | nullOpcional
executionWorkspaceSettings.workspaceStrategy.worktreeParentDirstring | nullOpcional
executionWorkspaceSettings.workspaceStrategy.provisionCommandstring | nullOpcional
executionWorkspaceSettings.workspaceStrategy.runtimeProvisionCommandstring | nullOpcional
executionWorkspaceSettings.workspaceStrategy.teardownCommandstring | nullOpcional
executionWorkspaceSettings.workspaceRuntimeobject | nullOpcional
executionWorkspaceSettings.networkEgressobject | nullOpcional
executionWorkspaceSettings.networkEgress.allowFqdnsarray<string>Opcional
each at most 253 charactersexecutionWorkspaceSettings.networkEgress.allowCidrsarray<string>Opcional
each at most 64 charactersRespuestas
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).
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.