Справочник API публикуется на английском языке.
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.
Авторизация
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 characterssourcestringНеобязательный
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 charactersexecutionWorkspaceSettings.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. Подробнее: ошибки и ограничения.