Emboss · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Getemboss Ai Artifacts API

3 actions 3 updates phrasing extends openapi/getemboss-ai-artifacts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Emboss's API. It is a proposal applied on top of the contract, not a document Emboss publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/artifacts/{artifact_id}'].get
$.paths['/artifacts/{artifact_id}/content'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Getemboss Ai Artifacts API
  version: 1.0.0
extends: openapi/getemboss-ai-artifacts-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: 2
- target: $.paths['/artifacts/{artifact_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an artifact's metadata
      effect: read
      questions:
      - What do I know about a generated document artifact, like its type and size?
      - Can I look up an artifact without downloading its bytes?
      instructions:
      - text: Get artifact {artifact_id}.
        slots:
          artifact_id: path.artifact_id
      - text: Show the metadata for artifact {artifact_id}.
        slots:
          artifact_id: path.artifact_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/artifacts/{artifact_id}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an artifact's content
      effect: read
      questions:
      - How do I download the actual file behind an artifact?
      - Where are the bytes of a generated PDF artifact served from?
      instructions:
      - text: Download the content of artifact {artifact_id}.
        slots:
          artifact_id: path.artifact_id
      - text: Save the file for artifact {artifact_id}.
        slots:
          artifact_id: path.artifact_id
      method: generated
      generated: '2026-10-01'