Opencode
- PATCH
- /workspaces
- /:workspace
- /projects
- /:project_name
- /pipelines
- /:pipeline_id
- /actions
- /:action_id
Update Opencode action configuration
Warning
You can't change the type of an existing action. To change the type, remove the action and add it again.
Request
REQUIRED SCOPES
PIPELINE_WRITE
URL PARAMETERS
workspacerequiredstring
The human-readable ID of the workspaceExample: "my-company"
project_namerequiredstring
The human-readable ID of the projectExample: "my-project"
pipeline_idrequiredinteger
The ID of the pipelineExample: 123
action_idrequiredinteger
The ID of the actionExample: 456
BODY PARAMETERS
typerequiredstring
The type of the actionValue: OPENCODE
after_action_idinteger
The numerical ID of the action, after which this action should be addednamerequiredstring
The name of the actiontrigger_timestring enum
Specifies when the action should be executed. ON_SUCCESS actions run after every successful run, also one ended by an EARLY_EXIT actionAllowed enum:
ON_EVERY_EXECUTION,ON_SUCCESS,ON_FAILURE,ON_BACK_TO_SUCCESS,ON_WARNING,ON_WAIT_FOR_APPROVE,ON_TERMINATEtrigger_conditionsTriggerConditionView[]
The list of trigger conditions to meet so that the action can be triggeredrun_nextstring enum
Defines whether the action should run in parallel with the next oneAllowed enum:
WAIT_ON_SUCCESS,IN_SOFT_PARALLEL,IN_HARD_PARALLELrun_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILUREvariablesEnvironmentVariableView[]
The list of variables you can use the actiondisabledboolean
When set to true the action is disabled. By default it is set to falsetimeoutinteger
The timeout in secondsignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actionsretry_countinteger
Number of retries if the action failsretry_intervalinteger
Delay time between auto retries in secondsloopstring[]
Names of the variables to loop over (IMAGES, not $IMAGES and not a value). The action runs once for each item of the value, and once for each combination of items when several variables are listed. The variable value is split into items by new lines, or by commas when it has no new lines (a single-line JSON object or key=value pairs stays one item). An item that is a JSON object or key=value pairs also sets one variable per key, named <VARIABLE>_<key>; an item that starts with EXTRACT: sets them as plain <key>.current_revisionstring
The git revision of the last successful run of the actionworking_directorystring
The directory in which the pipeline filesystem will be mountedsetup_commandsstring[]
The command that will be executed only on the first runservicesServiceView[]
The list of services attached to the build environmentmain_service_namestring
The hostname of the container in which the action is run. The container will be available under this name in the docker network for servicesintegrationDockerIntegrationRef
The integration used by the actionpromptsLlmBuildPromptView[]
List of prompts to send to the agent. Each prompt has a type (INLINE or FILE) and a value.modelstring
The Opencode model to use (e.g. anthropic/claude-sonnet-4-5).skillsstring[]
List of skills to install before the agent runs. Each entry is a source: owner/repo, a full Git/GitHub/GitLab URL (optionally pointing at a single skill via a /tree/<ref>/<subdir> path), or a path relative to the workspace.mcp_serversobject
Map of MCP servers to connect to, keyed by server name. Tools exposed by declared servers are auto-allowed.configstring
Inline opencode.json configuration. Mutually exclusive with config_file.config_filestring
Path to an opencode.json file in the workspace. Mutually exclusive with config.Response
RESPONSE BODY
typestring
The type of the actionValue: OPENCODE
urlread-onlystring
API endpoint to GET this objecthtml_urlread-onlystring
Web URL to view this object in Buddy.worksidinteger
The ID of the actionnamestring
The name of the actioncurrent_revisionstring
The git revision of the last successful run of the actiontrigger_timestring enum
Specifies when the action should be executed. ON_SUCCESS actions run after every successful run, also one ended by an EARLY_EXIT actionAllowed enum:
ON_EVERY_EXECUTION,ON_SUCCESS,ON_FAILURE,ON_BACK_TO_SUCCESS,ON_WARNING,ON_WAIT_FOR_APPROVE,ON_TERMINATEtrigger_conditionsTriggerConditionView[]
The list of trigger conditions to meet so that the action can be triggeredrun_nextstring enum
Defines whether the action should run in parallel with the next oneAllowed enum:
WAIT_ON_SUCCESS,IN_SOFT_PARALLEL,IN_HARD_PARALLELrun_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILUREvariablesEnvironmentVariableView[]
The list of variables you can use the actiondisabledboolean
When set to true the action is disabled. By default it is set to falsetimeoutinteger
The timeout in secondsignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actionsretry_countinteger
Number of retries if the action failsretry_intervalinteger
Delay time between auto retries in secondslast_execution_statusstring enum
The status of the last run of the actionAllowed enum:
INPROGRESS,ENQUEUED,TERMINATED,SUCCESSFUL,FAILED,INITIAL,NOT_EXECUTED,SKIPPED,TERMINATING,WAITING_FOR_APPLY,WAITING_FOR_VARIABLES,WAITING_FOR_SETTABLE_VARIABLES,WAITING_FOR_VT_SESSIONpipelineShortPipelineView
Short representation of a pipelinepermissionsPermissionsView
Access permissions configurationloopstring[]
Names of the variables to loop over (IMAGES, not $IMAGES and not a value). The action runs once for each item of the value, and once for each combination of items when several variables are listed. The variable value is split into items by new lines, or by commas when it has no new lines (a single-line JSON object or key=value pairs stays one item). An item that is a JSON object or key=value pairs also sets one variable per key, named <VARIABLE>_<key>; an item that starts with EXTRACT: sets them as plain <key>.working_directorystring
The directory in which the pipeline filesystem will be mountedsetup_commandsstring[]
The command that will be executed only on the first runservicesServiceView[]
The list of services attached to the build environmentmain_service_namestring
The hostname of the container in which the action is run. The container will be available under this name in the docker network for servicespromptsLlmBuildPromptView[]
List of prompts to send to the agent. Each prompt has a type (INLINE or FILE) and a value.modelstring
The Opencode model to use (e.g. anthropic/claude-sonnet-4-5).skillsstring[]
List of skills to install before the agent runs. Each entry is a source: owner/repo, a full Git/GitHub/GitLab URL (optionally pointing at a single skill via a /tree/<ref>/<subdir> path), or a path relative to the workspace.mcp_serversobject
Map of MCP servers to connect to, keyed by server name. Tools exposed by declared servers are auto-allowed.integrationIntegrationIdentifierView
The integration used by the actionconfigstring
Inline opencode.json configuration. Mutually exclusive with config_file.config_filestring
Path to an opencode.json file in the workspace. Mutually exclusive with config.Last modified on Nov 17, 2026
Request example
curl -X PATCH "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions/:action_id" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"name": "Opencode",
"type": "OPENCODE",
"trigger_time": "ON_EVERY_EXECUTION",
"integration": {
"identifier": "my-opencode-integration"
},
"prompts": [
{
"type": "INLINE",
"value": "Review the code and suggest improvements"
}
],
"model": "anthropic/claude-sonnet-4-5"
}'STATUS
200 OK