Pix4Dengine Cloud - First Example

Information: For an extensive description of all possible commands, see the interactive documentation (requires valid Pix4Dengine Cloud credentials).

After obtaining the Pix4D API access key, it will be necessary to retrieve an authentication token (see Authentication).

This article explains how to upload a new project, get it processed and finally access the results:

  • Create a new project:
    POST on https://cloud.pix4d.com/project/api/v3/projects/

  • Retrieve the temporary AWS S3 credentials associated with this project: 
    GET on https://cloud.pix4d.com/project/api/v3/projects/{id}/s3_credentials/

  • Upload your files to the given S3 location, through the preferred mean. 
    It is recommended to use the shell awscli CLI or the python boto3 library but other tools can work as well
    Make sure to prefix all your desired destination locations with the path returned in the credentials call. This is the only place for which write access is granted. 
    Make sure that the files are proper images and their names include an extension supported by Pix4Dmapper

  • It is possible to upload files that are not project inputs, and it is not possible to know which files are meant as input. It is therefore required to register each S3 uploaded file in the API. Register the uploaded files you uploaded (single API call):
    POST on https://cloud.pix4d.com/project/api/v3/projects/{id}/inputs/bulk_register/

  • Instruct Pix4D to start processing your project:
    POST on https://cloud.pix4d.com/project/api/v3/projects/{id}/start_processing/

  • Wait for the project to be processed. It is possible to query the project's status: 
    GET on https://cloud.pix4d.com/project/api/v3/projects/{id}/

  • Once the project is processed, by querying its details, it is possible to:
    • Get its Pix4D Cloud visualization page
    • Get its Pix4D Cloud public page link (read-only)
    • Get any asset that was produced ( in the form of an S3 link to the asset to be downloaded)
    GET on https://cloud.pix4d.com/project/api/v3/projects/{id}/


Was this article helpful?
3 out of 6 found this helpful

Article feedback (for troubleshooting, post here)


Article is closed for comments.