Saltar para a documentação
API

Iniciar uma exportação

Um zip de todo o espaço de trabalho, feito em segundo plano.

POST/exports

Executa a chamada real no seu espaço de trabalho.

POST /exports

Um zip de todo o espaço de trabalho, feito em segundo plano.

Exemplo

Precisa de threads:read. Não leva corpo e responde 201 com a exportação, queued. Leia-a até status ser ready e depois transfira-a.

curl
curl -X POST "$OE/exports" -H "$AUTH"
Resposta
{  "object": "export",  "id": "exp_8c1e4a7f2b9d3e6a0c5f1b28",  "status": "queued",  "phase": null,  "createdAt": "2026-09-30T09:12:44.000Z",  "createdBy": { "name": "Ana Lima", "email": "[email protected]" },  "startedAt": "2026-09-30T09:12:46.000Z",  "finishedAt": "2026-09-30T09:31:02.000Z",  "expiresAt": "2027-09-30T09:31:02.000Z",  "sizeBytes": 1840233472,  "fileName": "acme_20260930_093102.zip",  "threadsDone": 18420,  "threadsTotal": 18420,  "error": null}

Só corre uma exportação de cada vez: outra enquanto é feita é um 409 already_running. Um espaço de trabalho pode ser exportado uma vez por dia, e uma exportação dentro desse dia é um 429 export_limit_reached.

Uma aplicação pede primeiro um código de verificação: até ter verificado um, a chamada responde 403 step_up_required. A uma chave de API nunca é pedido.

Referência