Sign in
AgentInstruction

Update an agent instruction

Updates an existing agent instruction

patch/agentInstruction/{instruction_id}

Path parameters

instruction_idstring required

The ID of the agent instruction to update

Headers

If-Matchstring

ETag for optimistic locking

Request body

instruction_idstring

Unique identifier for the instruction

workspace_idstring

The workspace this instruction belongs to

namestring

A short name or title for the instruction

instruction_textstring

The instruction itself (plain text)

disabledboolean

Whether the instruction is disabled. Disabled instructions are not injected into agent prompts.

capabilitiesAgentInstructionCapability[]

Capabilities this instruction applies to

test_typesTestTypeEnum[]

Test types this instruction applies to

environment_idsstring[]

Environment IDs this instruction applies to

application_idsstring[]

Application IDs this instruction applies to

created_by_idstring

The user who created this instruction

created_timeinteger

Creation timestamp in epoch milliseconds

last_updated_by_idstring

The user who last updated this instruction

last_updated_timeinteger

Last update timestamp in epoch milliseconds

Response

The updated agent instruction

instruction_idstring

Unique identifier for the instruction

workspace_idstring

The workspace this instruction belongs to

namestring

A short name or title for the instruction

instruction_textstring

The instruction itself (plain text)

disabledboolean

Whether the instruction is disabled. Disabled instructions are not injected into agent prompts.

capabilitiesAgentInstructionCapability[]

Capabilities this instruction applies to

test_typesTestTypeEnum[]

Test types this instruction applies to

environment_idsstring[]

Environment IDs this instruction applies to

application_idsstring[]

Application IDs this instruction applies to

created_by_idstring

The user who created this instruction

created_timeinteger

Creation timestamp in epoch milliseconds

last_updated_by_idstring

The user who last updated this instruction

last_updated_timeinteger

Last update timestamp in epoch milliseconds

Changes