Adobe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Substance 3D API - Firefly Services Scenes API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v1/scenes/assemble'].post
$.paths['/v1/scenes/convert'].post
$.paths['/v1/scenes/describe'].post
$.paths['/v1/scenes/render'].post
$.paths['/v1/scenes/render-basic'].post

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 Adobe Substance 3D API - Firefly Services Scenes API
  version: 1.0.0
extends: openapi/adobe-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 from source files
      effect: write
      questions:
      - How do I assemble several 3D models into one scene with Substance 3D?
      - Which file encodings can an assembled scene be saved in?
      instructions:
      - text: Assemble a 3D scene {scene} from {sources} and save it as {fileBaseName} in {encoding}.
        slots:
          scene: requestBody.scene
          sources: requestBody.sources
          fileBaseName: requestBody.fileBaseName
          encoding: requestBody.encoding
      - text: Build a scene file named {fileBaseName} from these source models {sources} in {encoding} format.
        slots:
          fileBaseName: requestBody.fileBaseName
          sources: requestBody.sources
          encoding: requestBody.encoding
      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 into a different 3D format?
      - What if my 3D upload has several files, how do I pick the main model to convert?
      instructions:
      - text: Convert the 3D model in {sources} to {format}.
        slots:
          sources: requestBody.sources
          format: requestBody.format
      - text: Convert {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 is inside a 3D scene file, such as its meshes, materials and cameras?
      - Can I inspect a 3D file's structure before rendering it?
      instructions:
      - text: Describe the 3D scene in {sources}.
        slots:
          sources: requestBody.sources
      - text: Describe 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 to an image
      effect: write
      questions:
      - How do I render a product image from a 3D model with a ground plane and auto framing?
      - Can I render from a specific camera in my 3D scene?
      - What extra outputs can the full render produce besides the main image?
      instructions:
      - text: Render scene {scene} from {sources} at size {size}.
        slots:
          scene: requestBody.scene
          sources: requestBody.sources
          size: requestBody.size
      - text: Render scene {scene} from {sources} through camera {cameraName} with a {background} background.
        slots:
          scene: requestBody.scene
          sources: requestBody.sources
          cameraName: requestBody.cameraName
          background: requestBody.background
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scenes/render-basic'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a 3D object with the basic renderer
      effect: write
      questions:
      - Is there a basic, lighter version of the 3D render call?
      - Can I get a quick basic render of a 3D model without the full renderer?
      instructions:
      - text: Do a basic render of scene {scene} from {sources}.
        slots:
          scene: requestBody.scene
          sources: requestBody.sources
      - text: Use the basic renderer on scene {scene} from {sources} at size {size}.
        slots:
          scene: requestBody.scene
          sources: requestBody.sources
          size: requestBody.size
      method: generated
      generated: '2026-09-26'