Agents

Change an agent

Changes the name, instructions, trigger, actions (the whole set: anything not listed is denied), limits or status. Fields you leave out stay as they are. status paused stops new runs; active starts them again.

patch/agents/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/agents/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: project:write)

Path parameters

idstring uuid required

The id of the agent.

Request body

namestring

A short name, like New contact request follow-up.

instructionsstring

What the agent should do, in plain language, like: Send the owner a short summary of every new contact request and propose a call back.

status'active' | 'paused'

paused stops new runs; active starts them again.

Response

The agent as it is now.

idstring uuid required
namestring required
instructionsstring required
triggerobject required
actionsobject required
status'active' | 'paused' required
mode'live' | 'test' required
next_run_atstring nullable required
pending_approvalsinteger required
created_bystring nullable required

The key (key:<id>) or connected app (oauth:<id>) that created the agent.

created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.