自动化

修改自动化

Changed on

只修改请求中出现的字段，其余保持不变

put/automations/{id}

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/automations/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

自动化 ID

Request body

access_level'read_only' | 'confirm' | 'auto_write'
approval_timeout_minutesinteger

How long a run waits for an approval before it fails, in minutes

carry_last_resultboolean

Whether each per_run conversation gets the last successful answer

descriptionstring

What it is for

enabledboolean

Whether it is scheduled; on update use pause and resume instead

instructionstring

The task, sent as the user message of each run. May name now, last_run_at, last_success_at, run_id or automation_name inside double curly braces to have it filled in

misfire_policy'skip' | 'run_once'

What happens to runs missed while the service was down or paused

model_idstring

Optional chat model from model.list; empty follows the assistant default

namestring

What the automation is called

notify_on_successboolean

Whether a successful run notifies the owner

overlap_policy'skip' | 'queue'

What happens when a run is due while the previous one is still going

session_mode'per_run' | 'persistent'

per_run starts a new conversation each run; persistent keeps one

Response

修改后的自动化

successboolean

Example response

{
  "success": true
}

Changes