FruxonDocs
ApiAgent

Generates a version note from a diff summary via Server-Sent Events

Produces a short, human-readable release note summarizing a set of staged changes, streamed over SSE. Unlike the chat endpoint this is stateless — it neither reads nor writes conversation history — so it can be called on its own whenever a draft is about to be published.

POST
/v1/tenants/{tenant}/agents/{agent}/copilot:generateVersionNote

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

agent*string

The agent identifier.

tenant*string

The tenant identifier

Request Body

The request containing the diff summary text.

diffSummary?string

A human-readable summary of changes (added/removed/modified steps, parameter changes, etc.) produced by the frontend diff engine.

baseRevision?integer

The revision the pending save is based on — the one the editor has open, whose stored configuration the diff is expressed against. The server reads that revision to describe what the agent already is, so a note can say what a change means for this agent rather than restating the delta in the abstract.

Formatint64
[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/agents/string/copilot:generateVersionNote" \  -H "Content-Type: application/json" \  -d '{}'
"string"
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}