Request

Response

    Start processing
    POST

    photoscene/{photosceneid}

    Starts photoscene processing.

    The main processing steps involve: camera calibration, mesh reconstruction, texturing, and any necessary output file format conversions, in that order.

    This method should not be called until a photoscene has been created and at least three images have been added to the photoscene.

    Note: Progress of the processing can be monitored with the GET photoscene/:photosceneid/progress method.

    Resource Information

    Method and URI
    POST
    https://developer.api.autodesk.com/photo-to-3d/v1/photoscene/{photosceneid}
    Authentication Context
    user context optional
    Required OAuth Scopes
    data:write
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is obtained via either a two-legged or three-legged OAuth flow.
    * Required

    Request

    URI Parameters

    photosceneid
    string
    Specifies the ID of the photoscene

    Response

    HTTP Status Code Summary

    200
    OK
    Processing of the photoscene was successfully started
    403
    Forbidden
    Unauthorized

    Response

    Body Structure (200)

    Expand all
    Photoscene
    object
    An object containing details of the photoscene.
    photosceneid
    string
    ID of the photoscene
    Error
    object
    Even though the the service returns a HTTP Status Code of 200, it may return an error payload, which provides details on why the operation failed.
    code
    int
    A code that identifies the error type. See Error List for possible values
    msg
    string
    A short, human readable explanation of the error

    Example 1

    This example demonstrates succesfully starting processing the photoscene having photosceneid AtAuFsedTdqWdhF9VzHepp5oM9PITiuizI4xdMbzxHQ

    Request

    curl -v 'https://developer.api.autodesk.com/photo-to-3d/v1/photoscene/AtAuFsedTdqWdhF9VzHepp5oM9PITiuizI4xdMbzxHQ' \
      -X 'POST' \
      -H 'Authorization: Bearer eyjhbGCIOIjIuzI1NiISimtpZCI6...'
    

    Response

    {
      "msg": "No error",
      "Photoscene": {
        "photosceneid": "AtAuFsedTdqWdhF9VzHepp5oM9PITiuizI4xdMbzxHQ"
      }
    }
    

    Example 2

    This example demonstrates an unsuccesfull attempt at starting processing because the photosceneid xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx doesn’t exist.

    Request

    curl -v 'https://developer.api.autodesk.com/photo-to-3d/v1/photoscene/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
      -X 'POST' \
      -H 'Authorization: Bearer eyjhbGCIOIjIuzI1NiISimtpZCI6...'
    

    Response

    {
      "Error": {
        "code": "19",
        "msg": "Specified photoscene ID doesn't exist in the database"
      }
    }