# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Substance 3D API - Firefly Services Scenes API
  version: 1.0.0
extends: openapi/adobe-suite-scenes-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: 5
- target: $.paths['/v1/scenes/assemble'].post
  update:
    x-apievangelist-phrasing:
      intent: Assemble a 3D scene
      effect: write
      questions:
      - How do I combine several 3D models into one scene with the Substance 3D API?
      - What output encoding options are there when assembling a scene?
      instructions:
      - text: Assemble scene {scene} from sources {sources} and save it as {fileBaseName} in {encoding}.
        slots:
          scene: requestBody.scene
          sources: requestBody.sources
          fileBaseName: requestBody.fileBaseName
          encoding: requestBody.encoding
      - text: Build a 3D scene from {sources} and wait for it to finish ({wait}).
        slots:
          sources: requestBody.sources
          wait: query.wait
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scenes/convert'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a 3D file to another format
      effect: write
      questions:
      - Can I convert an FBX model to GLB or USDZ?
      - Which file do I point to when a 3D upload contains several models?
      instructions:
      - text: Convert {sources} to {format}.
        slots:
          sources: requestBody.sources
          format: requestBody.format
      - text: Convert model {modelEntrypoint} from {sources} into {format}.
        slots:
          modelEntrypoint: requestBody.modelEntrypoint
          sources: requestBody.sources
          format: requestBody.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scenes/describe'].post
  update:
    x-apievangelist-phrasing:
      intent: Describe the contents of a 3D scene
      effect: read
      questions:
      - What cameras, meshes and materials are inside my 3D file?
      - Can I inspect a 3D scene's structure without rendering it?
      instructions:
      - text: Describe the 3D scene in {sources}.
        slots:
          sources: requestBody.sources
      - text: Tell me what is in scene file {sceneFile} from {sources}.
        slots:
          sceneFile: requestBody.sceneFile
          sources: requestBody.sources
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scenes/render'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a 3D object with full options
      effect: write
      questions:
      - How do I render a product image from a 3D model with a ground plane and custom background?
      - Can I request extra render outputs like depth or masks?
      instructions:
      - text: Render scene {scene} from {sources} at size {size} using camera {cameraName}.
        slots:
          scene: requestBody.scene
          sources: requestBody.sources
          size: requestBody.size
          cameraName: requestBody.cameraName
      - text: Render {scene} from {sources} with background {background} and extra outputs {extraOutputs}.
        slots:
          scene: requestBody.scene
          sources: requestBody.sources
          background: requestBody.background
          extraOutputs: requestBody.extraOutputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scenes/render-basic'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a 3D object (basic version)
      effect: write
      questions:
      - Is there a simpler basic render endpoint for a quick 3D preview?
      - Can the basic 3D render auto-frame the object for me?
      instructions:
      - text: Do a basic render of scene {scene} from {sources}.
        slots:
          scene: requestBody.scene
          sources: requestBody.sources
      - text: Run the basic renderer on {scene} from {sources} with auto framing {autoFraming}.
        slots:
          scene: requestBody.scene
          sources: requestBody.sources
          autoFraming: requestBody.autoFraming
      method: generated
      generated: '2026-09-26'