---
title: "Request Export"
method: POST
path: "/api/v1/skybox/export"
tags: ["Skybox Exports"]
---

# Request Export

`POST /api/v1/skybox/export`

## Request

- Base URL: `https://backend.blockadelabs.com`
- URL: `https://backend.blockadelabs.com/api/v1/skybox/export`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/blockadelabs/apis/blockade-labs-api-documentation/docs/api/v1/skybox/export/post.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Headers

- `x-api-key` string

## Request body

- object
  - `skybox_id` string, required: Skybox obfuscated_id (needs to have status=complete)
  - `type_id` integer, required: Export type id.
  - `resolution_id` integer: Export resolution id.
  - `mesh_quality_id` integer: Export 3D mesh quality id.
  - `depth_scale` number: Depth scale for 3D mesh exports (between 3 and 10).
  - `webhook_url` string: Optionally, you may specify a webhook url to specify the destination for progress updates.

## Response `200`

- object
  - `file_url` string: URL for the exported file
  - `id` string: ID of your export request. It can be used to track progress or cancel the request
  - `skybox_obfuscated_id` string: Obfuscated ID of the skybox for which the export was requested
  - `type` string: Requested export type
  - `type_id` integer: Requested export type ID
  - `status` string: 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_position` integer: Position of your request in a export generation queue
  - `error_message` string: If status=error here you should see the error message
  - `pusher_channel` string: Pusher channel name used to track export generation progress
  - `pusher_event` string: Pusher channel event used to track generation
  - `webhook_url` string
  - `created_at` string: Time created

---

[API](https://skmtc.dev/blockadelabs/apis/blockade-labs-api-documentation.md) - [All operations](https://skmtc.dev/blockadelabs/apis/blockade-labs-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/blockadelabs/apis/blockade-labs-api-documentation/revisions/7560ac18c09c?raw)