Sign in
ContentEditorCopilot

Stream a content editing copilot chat response

post/api/v1/content-editor

Request body

conversationIdstring

Stable per-chat-session id used to group the conversation's AI spans in Sentry (gen_ai.conversation.id).

documentIdsstring[]

Organization documents to ground this turn's generations in, as selected by the author in the Studio. Their full text is folded into each tool call's instruction.

{"stackTrail":"components:schemas:ContentEditorCopilotChatRequestDTO:properties:draft","oasType":"schema","type":"unknown","description":"Transitional: the draft as the browser holds it. Sending it makes the turn ground on it and commit it to the record first; omit it and the turn grounds on the stored draft, which the form writes every edit to. Ignored once the client sends only `draftId`, and removed in a follow-up."}
draftIdstring uuid

The stored draft this turn's tools operate on, opened via POST /content-draft. Absent, no draft-changing tool is offered for the turn.

missionIdstring

The mission this authoring session started from. Forwarded to the model provider as telemetry metadata only - it is never used as a lookup or authorization key.

orgDescriptionstring

Organization description used to ground the chat system prompt. Tenant-supplied reference data, on the same footing as orgName.

orgNamestring

Organization name used to ground the chat system prompt. Tenant-supplied reference data, not a fact: the tools resolve org context server-side themselves.

uiLanguage'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'zh-Hans' required

UI language of the requesting user

Changes