Generated by API Evangelist
Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Content Body API
version: 1.0.0
extends: openapi/atlassian-content-body-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/wiki/rest/api/contentbody/convert/{to}'].post
update:
x-apievangelist-phrasing:
intent: Convert page content between formats
effect: read
questions:
- How do I turn Confluence storage format into rendered HTML?
- Which content body conversions, like storage to editor, are supported?
instructions:
- text: Convert {value} from {representation} to {to} format.
slots:
value: requestBody.value
representation: requestBody.representation
to: path.to
- text: Render storage-format body {value} as {to} in the context of space {spaceKeyContext}.
slots:
value: requestBody.value
to: path.to
spaceKeyContext: query.spaceKeyContext
method: generated
generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/contentbody/convert/async/{to}'].post
update:
x-apievangelist-phrasing:
intent: Start an async content body conversion
effect: read
questions:
- Can I convert a large page body to export view in the background?
- What do I get back when I start an asynchronous content conversion?
instructions:
- text: Start an async conversion of {value} from {representation} to {to}.
slots:
value: requestBody.value
representation: requestBody.representation
to: path.to
- text: Queue a background conversion of this body to {to}, allow cache {allowCache}.
slots:
to: path.to
allowCache: query.allowCache
method: generated
generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/contentbody/convert/async/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an async conversion result
effect: read
questions:
- Has my asynchronous content conversion finished yet?
- How long is the result of a background conversion kept?
instructions:
- text: Get the async conversion result for {id}.
slots:
id: path.id
- text: Check the status of content conversion task {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.