Write a summary revision (Summarizer built-in agent only)

PUT/api/companies/{companyId}/summary-slots/{scopeKind}/{slotKey}
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Write a summary revision (Summarizer built-in agent only).

Authorization

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.
scopeKindstringRequiredThe scopekind's id.
slotKeystringRequiredThe scopekind's id.

Request body

application/json · required

scopeIdstring (uuid) | nullOptional
markdownstringRequired1–200000 characters
titlestring | nullOptional1–200 characters
changeSummarystring | nullOptional1–1000 characters
baseRevisionIdstring (uuid) | nullOptional
generationIssueIdstring (uuid) | nullOptional
modelstring | nullOptional1–200 characters

Responses

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Summaries