Emboss · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Getemboss Ai Sessions API

6 actions 6 updates phrasing extends openapi/getemboss-ai-sessions-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 6

$.info

$.paths['/sessions'].post

$.paths['/sessions/{sid}'].get

$.paths['/sessions/{sid}/fields'].put

$.paths['/sessions/{sid}/fill'].post

$.paths['/sessions/{sid}/pdf'].get

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 Getemboss Ai Sessions API
  version: 1.0.0
extends: openapi/getemboss-ai-sessions-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: 5
- target: $.paths['/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an interactive fill session for a form
      effect: write
      questions:
      - How do I start filling a form field by field interactively?
      - Can I open an editing session on one of my forms?
      instructions:
      - text: Start a fill session for form {form_id}.
        slots:
          form_id: requestBody.form_id
      - text: Open an interactive editing session on {form_id}.
        slots:
          form_id: requestBody.form_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a fill session's current field values
      effect: read
      questions:
      - What values have been entered so far in my fill session?
      - Can I resume a session and see its current state?
      instructions:
      - text: Show fill session {sid}.
        slots:
          sid: path.sid
      - text: Get the current field values in session {sid}.
        slots:
          sid: path.sid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sid}/fields'].put
  update:
    x-apievangelist-phrasing:
      intent: Set field values in a fill session
      effect: write
      questions:
      - How do I enter or change answers in an open fill session?
      - Can I update several fields in a session at once?
      instructions:
      - text: Update session {sid} fields with {updates}.
        slots:
          sid: path.sid
          updates: requestBody.updates
      - text: Set these answers {updates} in fill session {sid}.
        slots:
          updates: requestBody.updates
          sid: path.sid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sid}/fill'].post
  update:
    x-apievangelist-phrasing:
      intent: Render the filled PDF for a session
      effect: write
      questions:
      - How do I finish a session and produce the filled PDF?
      - Once my session answers are in, how is the document generated?
      instructions:
      - text: Fill the form for session {sid}.
        slots:
          sid: path.sid
      - text: Generate the filled document from session {sid}'s answers.
        slots:
          sid: path.sid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sid}/pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a session's filled PDF
      effect: read
      questions:
      - Where do I download the PDF from a completed fill session?
      - Can I fetch the latest filled file for a session?
      instructions:
      - text: Download the PDF for session {sid}.
        slots:
          sid: path.sid
      - text: Save session {sid}'s filled form.
        slots:
          sid: path.sid
      method: generated
      generated: '2026-10-01'