Upload

Learn how to upload assets with a query.

Upload content entry

POST https://api.echo3D.com/upload

This endpoint allows you to upload or edit assets.

Headers

Name	Type	Description
Content-Type	string	Use multipart/form-data when uploading multiple files.

Request Body

Name	Type	Description
key*	string	Target collection key eg some-words-1234
email*	string	Your email address
userKey*	string	Your authentication key
file*	binary	The asset file associated with your request. Not required if using url
url*	string	The source url for the asset or AR target file. Not required if using file
target_type	integer	AR target type, defaults to 2 (BRICK / no target) if not specified. Options: 0 for IMAGE_TARGET, 1 for GEOLOCATION_TARGET, or 2 for BRICK_TARGET. See additional info about AR targets below.
data	string	A string representing metadata to add to the uploaded content. Format: key1:value1;key2:value2;...
secKey	string	Collection Security Key. Only if enabled through the Security page.
allowDuplicate	boolean	Set to true to allow duplicate uploads. Duplicates are detected via an md5 checksum of the uploaded file
noProcessingWait	boolean	By default, Server waits up to 5 minutes for asset processing to complete before responding with complete asset object data. Include noProcessingWait=true in your request to prompt server to respond with basic asset data when asset is first saved to your collection. Processing times vary according to file size, platform load and asset format. Includes conversions to web-friendly formats and 3D model screenshots.

200 Content successfully uploaded.

{
  "id": "3b020b06-9ba1-42f1-87e7-eec3b33617c0",
  "target": {
    "id": "147fdbe5-2724-44ed-b6ec-31ae8bbbe50a",
    "type": "BRICK_TARGET",
    "holograms": [
      "bca5895d-29c6-4e74-b843-a014bdb0962c"
    ]
  },
  "hologram": {
    "filename": "Skyscraper.obj",
    "storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
    "textureFilenames": [
      "Skyscraper_BaseColor.png"
    ],
    "textureStorageIDs": [
      "f9b43711-cf79-44e5-90c5-ac781c8d9288"
    ],
    "materialFilename": "Skyscraper.mtl",
    "materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
    "id": "bca5895d-29c6-4e74-b843-a014bdb0962c",
    "type": "MODEL_HOLOGRAM",
    "targetID": "147fdbe5-2724-44ed-b6ec-31ae8bbbe50a"
  },
  "sdks": [
    true,
    true,
    false,
    true,
    false,
    false,
    false,
    true,
    true
  ],
  "additionalData": {
    "accessHistory": "[\"1586222284478\"]",
    "createdAt": "1586222284478",
    "glbHologramStorageFilename": "Skyscraper.glb",
    "glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
    "lastAccessed": "1586222284478",
    "qrARjsMarkerStorageFilename": "marker_qr_arjs_blue-water-4646.png",
    "qrARjsMarkerStorageID": "5d8dc812-12ba-43a6-b00d-6f199bde16ce",
    "qrARjsStorageFilename": "qr_arjs_blue-water-4646.png",
    "qrARjsStorageID": "f32c0d9f-15b9-45b6-9371-630384ad588f",
    "qrARjsTargetStorageFilename": "qr_arjs_blue-water-4646.patt",
    "qrARjsTargetStorageID": "18e93bb9-a535-4764-94a4-6d6e5a16e260",
    "qrWebXRStorageFilename": "qr_webxr_blue-water-4646.png",
    "qrWebXRStorageID": "fbd798e7-fc13-43cd-bc9d-cfa0df1aabb6",
    "source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
    "vuforiaHologramStorageFilename": "Skyscraper.h",
    "vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475"
  }
}

400 Could not find an API key in this query.

200 Processing Timeout

Target Type

Target types can be one of the following:

0 for IMAGE_TARGET

If you choose to use an image as your AR target, you must also add to your request one of the following:

• url_image: A URL to the image you want to use as a target

• file_image: The image file you want to use as a target. The file will be uploaded as Part.

1 for GEOLOCATION_TARGET

A location target must be associated with a location. You must either send an address or send location coordinates (longitude and latitude):

• text_geolocation: Address for the location.

• longitude and latitude: Longitude and latitude coordinates

2 for BRICK_TARGET

A surface target; needs no additional arguments.

Examples

Here are a few upload API examples using Postman.

1. Uploading an asset from a url

1. Uploading an asset from a local file on your PC

1. Uploading a model asset on a brick target from a third-party search engine:

• type is search, source is Sketchfab, and url includes an URL redirecting to the model

• hologram_type is 2

• target_type is 2

Uploading with Metadata

You can attach a .csv file that contains pairs of keys and values to the Upload API call to be added alongside the uploaded asset as data entries. Your request must include:

• file_csv that includes a file

Your metadata file should contain only two columns: one for keys and the second for values.

Here is a sample file you can use:

60B

metadata.csv

Open

Overwrite or Edit an Existing Entry

You can overwrite or edit an existing entry that was previously uploaded by using the upload API with a few additional parameters. Your request must include:

• edit_type that included the type of edit to make: hologram or target.

• entryId that included the Entry ID of the existing Entry to overwrite.

Batch Upload

If you would like to upload many assets at once, the following repository allows for customized batch uploads via a Python script and a CSV data file. Click here to access the repository on GitHub.

GitHub - echo3Dco/echo3D-Batch-Upload-scriptGitHub