Skip to content

Set the operator's principles

PUT
/api/v1/admin/principles
curl --request PUT \
--url http://localhost:11044/api/v1/admin/principles \
--header 'Content-Type: application/json' \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \
--data '{ "content": "example" }'

Replaces the shipped default for this appliance. Plain text/markdown; coding agents receive it verbatim in their authoring brief.

The principles as plain text or markdown in content, saved as the operator’s file in place of the shipped default and handed verbatim to coding agents in their authoring brief. Blank content is a 400: DELETE returns to the default

Media typeapplication/json

The operator’s architectural principles for PUT /admin/principles, replacing the shipped default for the whole appliance

object
content
required

The principles as plain text or markdown, stored as written and handed to coding agents verbatim in their authoring brief. Must not be blank; DELETE /admin/principles returns to the shipped default

string

Example generated

{
"content": "example"
}

Saved

Media type*/*
object

Blank content — use DELETE to return to the shipped default

Media type*/*

A refused write of the operator’s principles

object
message
required

Why the write was refused, written to be shown

string
status
required

Always error

string
Allowed values: error