BLblockadelabs
Skybox Exports

Request Export

Process for tracking export progress is identical to tracking skybox generation by using Pusher, Webhook or API Data pooling.

If the export request has already been completed you will immediately get a response with status=complete and file_url in the response.

post/api/v1/skybox/export

Request

Headers

x-api-keystring

Request body

skybox_idstring required

Skybox obfuscated_id (needs to have status=complete)

type_idinteger required

Export type id.

resolution_idinteger

Export resolution id.

mesh_quality_idinteger

Export 3D mesh quality id.

depth_scalenumber

Depth scale for 3D mesh exports (between 3 and 10).

webhook_urlstring

Optionally, you may specify a webhook url to specify the destination for progress updates.

Example request

{
  "skybox_id": "f87f6a4b3784591795bfed30100a9ef6",
  "type_id": 2,
  "resolution_id": 3,
  "mesh_quality_id": 2,
  "depth_scale": 5.3
}

Response

file_urlstring

URL for the exported file

idstring

ID of your export request. It can be used to track progress or cancel the request

skybox_obfuscated_idstring

Obfuscated ID of the skybox for which the export was requested

typestring

Requested export type

type_idinteger

Requested export type ID

statusstring

Initially status is set as 'pending' after you send the export request. Status will change from one state to another and you will get updates for each one if you are using pusher or webhook: pending -> dispatched -> processing -> complete. Also you can get abort or error and in some cases (ie. for JPG and Depth Map export) this will be immediately set to 'complete'.

queue_positioninteger

Position of your request in a export generation queue

error_messagestring

If status=error here you should see the error message

pusher_channelstring

Pusher channel name used to track export generation progress

pusher_eventstring

Pusher channel event used to track generation

webhook_urlstring
created_atstring

Time created

Example response

{
  "file_url": "https://blockade-platform-production.s3.amazonaws.com/exports/equirectangular-png/vr360-intricate-fantasy-art-dark-forest-vr360-c4d-computer-r_8442285_equirectangular-png.png",
  "id": "b26584eb869cdebeecdf009b7c17c73b",
  "skybox_obfuscated_id": "08ccb4947d546dec0ce454538ebb51a8",
  "type": "equirectangular-png",
  "type_id": 2,
  "status": "complete",
  "queue_position": 0,
  "error_message": null,
  "pusher_channel": "export_status_update_b26584eb869cdebeecdf009b7c17c73b",
  "pusher_event": "status_update",
  "webhook_url": "test_weebhook",
  "created_at": "2023-08-23T13:52:59.000000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.