Brault Developers

Start a ZIP download

Regionalus.api.brault.appfollows the region selector in the top bar
POST
/v1/downloads

Asynchronous. Poll /v1/downloads/{download_id} until status is ready, then use url.

AuthorizationBearer <token>

API key from Settings → Developers

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/downloads" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "download",  "id": "string",  "status": "queued",  "progress": 0,  "object_count": 0,  "url": "string",  "size": 0,  "error_code": "string"}