Ghost · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ghost Content and Admin Admin - Images API

2 actions 2 updates phrasing extends openapi/ghost-org-admin-images-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Ghost's API. It is a proposal applied on top of the contract, not a document Ghost publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/admin/images/upload/'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Ghost Content and Admin Admin - Images API
  version: 1.0.0
extends: openapi/ghost-org-admin-images-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/admin/images/upload/'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an image for use in content
      effect: write
      questions:
      - How do I upload an image to Ghost and get back a URL I can put in a post?
      - Can I mark an uploaded image as a profile image or site icon?
      - Where does an uploaded image end up so I can reference it in page content?
      instructions:
      - text: Upload {file} as an image and give me its stored URL.
        slots:
          file: requestBody.file
      - text: Upload {file} with purpose {purpose} so it can be used as a profile picture.
        slots:
          file: requestBody.file
          purpose: requestBody.purpose
      - text: Upload image {file} and tag it with reference {ref}.
        slots:
          file: requestBody.file
          ref: requestBody.ref
      method: generated
      generated: '2026-09-26'