Generated by API Evangelist
Written by API Evangelist tooling for Confluence's API. It is a proposal applied on top of the contract, not a document Confluence publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Confluence Cloud REST API v2 Database API
version: 1.0.0
extends: openapi/confluence-database-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['/databases'].post
update:
x-apievangelist-phrasing:
intent: Create a database in a space
effect: write
questions:
- How do I create a new Confluence database in a space?
- Can I make a database private or nest it under a parent page?
instructions:
- text: Create a database titled {title} in space {spaceId}.
slots:
title: requestBody.title
spaceId: requestBody.spaceId
- text: Add a private database {title} under parent {parentId} in space {spaceId}.
slots:
title: requestBody.title
parentId: requestBody.parentId
spaceId: requestBody.spaceId
method: generated
generated: '2026-10-01'
- target: $.paths['/databases/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a database by id
effect: read
questions:
- How do I fetch the details of a specific Confluence database?
- Can I include a database's collaborators and direct children in the response?
instructions:
- text: Get database {id}.
slots:
id: path.id
- text: Show database {id} with its collaborators and direct children.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/databases/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Move a database to the trash
effect: destructive
questions:
- How do I delete a Confluence database?
- Can a deleted database be restored from the trash later?
instructions:
- text: Delete database {id}.
slots:
id: path.id
- text: Move database {id} to the trash.
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.