> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pulze.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create

> Create a comment, on a shot or without one.



## OpenAPI

````yaml /scene-manager-3/api-reference/openapi.json post /comments
openapi: 3.1.0
info:
  title: Scene Manager
  version: 3.0.0
  description: >-
    Scene Manager's local API, on the computer it runs on. Every call needs a
    Scene Manager licence on this computer.
servers:
  - url: http://127.0.0.1:45710/api/v1
    description: Scene Manager on this computer
security: []
tags:
  - name: Service
    description: Whether Scene Manager is running and connected to an app.
  - name: Setups
    description: 'Saved states of the scene: list, make, change, activate.'
  - name: Folders
    description: Folders of setups. A folder's values pass down to its setups.
  - name: Modules
    description: The parts of a setup (Camera, Output, Lights…) and the properties in them.
  - name: Rendering
    description: Batch render setups, follow the progress, stop.
  - name: Variations
    description: Sets of options rendered in every combination.
  - name: Comments
    description: Comments pinned on shots of the scene, for people and agents.
  - name: Shots
    description: Viewport and frame buffer captures that comments are pinned on.
  - name: Scene
    description: >-
      The open scene itself: its objects, materials, properties, selection and
      scripts.
  - name: Document
    description: Scene Manager's whole document in the open scene, and 2.x import.
  - name: Settings
    description: This person's settings on this computer.
  - name: HDRI library
    description: The HDRI maps in the library folders and in the scene.
paths:
  /comments:
    post:
      tags:
        - Comments
      summary: Create
      description: Create a comment, on a shot or without one.
      operationId: createComment
      requestBody:
        description: The comment
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  minLength: 1
                author:
                  allOf:
                    - $ref: '#/components/schemas/Author'
                    - description: Who writes it; the person at this machine when absent
                shot:
                  type: string
                setup:
                  type: string
                pin:
                  $ref: '#/components/schemas/ShotPoint'
                area:
                  $ref: '#/components/schemas/ShotArea'
                marks:
                  type: array
                  items:
                    $ref: '#/components/schemas/Mark'
                links:
                  type: array
                  items:
                    anyOf:
                      - type: string
                      - type: object
                        properties:
                          target:
                            type: string
                          name:
                            type: string
                          detail:
                            type: string
                        required:
                          - target
                  description: >-
                    What it is about: RenderKit addresses, or addresses with the
                    names they are shown by
                linkSelection:
                  type: boolean
                  description: Also link what is selected in the app
                assignee:
                  type: string
                  description: 'Hand it to someone: a person''s or an agent''s name'
              required:
                - text
      responses:
        '200':
          description: Written
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Comment'
        '400':
          description: Not an image
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '404':
          description: No such comment, shot or setup, or the app cannot do this
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '409':
          description: The scene is read-only
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '503':
          description: No DCC or CAD app is connected
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
components:
  schemas:
    Author:
      type: object
      properties:
        name:
          type: string
          minLength: 1
        kind:
          type: string
          enum:
            - person
            - agent
        via:
          type: string
        picture:
          type: string
          format: uri
      required:
        - name
        - kind
    ShotPoint:
      type: array
      prefixItems:
        - type: number
        - type: number
      description: x, y as fractions of the shot from the top left
    ShotArea:
      type: array
      prefixItems:
        - type: number
        - type: number
        - type: number
        - type: number
      description: x, y, width, height as fractions of the shot
    Mark:
      anyOf:
        - type: object
          properties:
            kind:
              type: string
              enum:
                - pen
            color:
              type: string
            points:
              type: array
              items:
                type: number
          required:
            - kind
            - color
            - points
        - type: object
          properties:
            kind:
              type: string
              enum:
                - line
                - arrow
                - rect
                - ellipse
            color:
              type: string
            from:
              $ref: '#/components/schemas/ShotPoint'
            to:
              $ref: '#/components/schemas/ShotPoint'
          required:
            - kind
            - color
            - from
            - to
        - type: object
          properties:
            kind:
              type: string
              enum:
                - text
            color:
              type: string
            at:
              $ref: '#/components/schemas/ShotPoint'
            text:
              type: string
            size:
              type: string
              enum:
                - small
                - normal
                - medium
                - large
          required:
            - kind
            - color
            - at
            - text
      description: >-
        A drawing on the shot; points are fractions of the picture from the top
        left
    Comment:
      type: object
      properties:
        id:
          type: string
        'n':
          type: number
        author:
          $ref: '#/components/schemas/Author'
        text:
          type: string
        at:
          type: string
        status:
          type: string
          enum:
            - open
            - resolved
        resolved:
          type: object
          properties:
            by:
              $ref: '#/components/schemas/Author'
            at:
              type: string
          required:
            - by
            - at
        shot:
          type: string
        setup:
          type: string
        pin:
          $ref: '#/components/schemas/ShotPoint'
        area:
          $ref: '#/components/schemas/ShotArea'
        marks:
          type: array
          items:
            $ref: '#/components/schemas/Mark'
        links:
          type: array
          items:
            type: object
            properties:
              target:
                type: string
              name:
                type: string
              detail:
                type: string
            required:
              - target
        assignee:
          type: string
        taken:
          type: object
          properties:
            by:
              $ref: '#/components/schemas/Author'
            at:
              type: string
          required:
            - by
            - at
        done:
          type: object
          properties:
            by:
              $ref: '#/components/schemas/Author'
            at:
              type: string
          required:
            - by
            - at
        replies:
          type: array
          items:
            $ref: '#/components/schemas/Reply'
      required:
        - id
        - 'n'
        - author
        - text
        - at
        - status
        - marks
        - links
        - replies
    Reply:
      type: object
      properties:
        id:
          type: string
        author:
          $ref: '#/components/schemas/Author'
        text:
          type: string
        at:
          type: string
        changes:
          type: array
          items:
            $ref: '#/components/schemas/MadeChange'
      required:
        - id
        - author
        - text
        - at
    MadeChange:
      type: object
      properties:
        target:
          type: string
        name:
          type: string
        param:
          type: string
        before: {}
        after: {}
        setup:
          type: string
      required:
        - target
        - param
      description: Something changed while handling a comment

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.