Agent

The AGENT reports that it carried out an instruction

PATCHhttps://backend.immut.io/api/v1/agent/instructions/{id}

Required scope: documents:write

{status: "applied"|"cancelled", runId?}. Deliberately separate from creating one, because a human clicking a button is not evidence the file was handled. Returns 404 for an instruction in another organisation.

Parameters

Name	In	Required	Description
`id`	path	yes	id of the target record

Request body

Content type: application/json (required)

Field	Type	Required	Description
`status`	string	yes	applied \| cancelled (required)
`runId`	string	no	the runId of the sweep that applied it (optional, recommended)

Responses

Status	Meaning
`200`	Success
`400`	BadRequest
`401`	Unauthorized
`403`	Forbidden
`429`	RateLimited

Example

curl -X PATCH "https://backend.immut.io/api/v1/agent/instructions/<id>" \
  -H "Authorization: Bearer $IMMUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"<status>","runId":"<runId>"}'

Generated from the immut API contract, version 1.9.0. Machine-readable: this page as markdown · everything in one file · OpenAPI